Notices: This section not yet converted to new layout. Download stats are rolling back out.

This is not the latest version of Boxstarter Common Module available.

Boxstarter Common Module

2.8.21

Package test results are passing.

This package was approved as a trusted package on 4/28/2016.

Provides common functions used by multiple Boxstarter Modules.

To install Boxstarter Common Module, run the following command from the command line or from PowerShell:

C:\> choco install boxstarter.common --version 2.8.21

To upgrade Boxstarter Common Module, run the following command from the command line or from PowerShell:

C:\> choco upgrade boxstarter.common --version 2.8.21

Files

Hide
  • tools\Boxstarter.Common\boxstarter.common.psd1
  • tools\Boxstarter.Common\Boxstarter.Common.psm1 Show
    Resolve-Path $PSScriptRoot\*.ps1 | 
        % { . $_.ProviderPath }
    
    Export-ModuleMember Confirm-Choice,`
                        Create-BoxstarterTask,`
                        Enter-BoxstarterLogable,`
                        Enter-DotNet4,`
                        Get-CurrentUser,`
                        Get-HttpResource,`
                        Get-IsMicrosoftUpdateEnabled,`
                        Get-IsRemote,`
                        Invoke-FromTask,`
                        Invoke-RetriableScript,`
                        Out-BoxstarterLog,`
                        Log-BoxstarterMessage,`
                        Remove-BoxstarterError,`
                        Remove-BoxstarterTask,`
                        Start-TimedSection,`
                        Stop-TimedSection,`
                        Test-Admin,`
                        Write-BoxstarterLogo,`
                        Write-BoxstarterMessage
    
    Export-ModuleMember -Variable Boxstarter
    
  • tools\Boxstarter.Common\Boxstarter.Common.pssproj
  • tools\Boxstarter.Common\Boxstarter.Common.pssproj.user
  • tools\Boxstarter.Common\Confirm-Choice.ps1 Show
    function Confirm-Choice {
    <#
    .SYNOPSIS
    Prompts the user to choose a yes/no option.
    
    .DESCRIPTION
    The message parameter is presented to the user and the user is then prompted to 
    respond yes or no. In environments such as the PowerShell ISE, the Confirm param 
    is the title of the window presenting the message.
    
    .Parameter Message
    The message given to the user that tels them what they are responding yes/no to.
    
    .Parameter Caption
    The title of the dialog window that is presented in environments that present 
    the prompt in its own window. If not provided, the Message is used.
    
    .LINK
    http://boxstarter.org
    
    #>
        param (
            [string]$Message, 
            [string]$Caption = $Message
        )
        $yes = new-Object System.Management.Automation.Host.ChoiceDescription "&Yes","Yes";
        $no = new-Object System.Management.Automation.Host.ChoiceDescription "&No","No";
        $choices = [System.Management.Automation.Host.ChoiceDescription[]]($yes,$no);
        $answer = $host.ui.PromptForChoice($caption,$message,$choices,0)
    
        switch ($answer){
            0 {return $true; break}
            1 {return $false; break}
        }    
    }
  • tools\Boxstarter.Common\Create-BoxstarterTask.ps1 Show
    function Create-BoxstarterTask{
    <#
    .SYNOPSIS
    Creates a Scheduled Task for Boxstarter operations that require a local 
    administrative token
    
    .DESCRIPTION
    Create-BoxstarterTask creates a scheduled task.  This task is present 
    throughout a boxstarter installation process and is used when Boxstarter
    needs to complete a task that cannot use a remote token. This function 
    does not run the task. It simply creates it.
    
    .Parameter Credential
    The credentials under which the task will run.
    
    .LINK
    http://boxstarter.org
    Invoke-FromTask
    Remove-BoxstarterTask
    
    #>
        param([Management.Automation.PsCredential]$Credential)
        Remove-BoxstarterError {
            if($Credential.GetNetworkCredential().Password.length -gt 0){
                schtasks /CREATE /TN 'Temp Boxstarter Task' /SC WEEKLY /RL HIGHEST `
                    /RU "$($Credential.UserName)" /IT /RP $Credential.GetNetworkCredential().Password `
                /TR "powershell -noprofile -ExecutionPolicy Bypass -File $env:temp\BoxstarterTask.ps1" /F | Out-Null
    
                #Give task a normal priority
                $taskFile = Join-Path $env:TEMP RemotingTask.txt
                Remove-Item $taskFile -Force -ErrorAction SilentlyContinue
                [xml]$xml = schtasks /QUERY /TN 'Temp Boxstarter Task' /XML
                if($xml.Task.Settings.Priority -eq $null) {
                    $priority = $xml.CreateElement("Priority", "http://schemas.microsoft.com/windows/2004/02/mit/task")
                    $xml.Task.Settings.AppendChild($priority)
                }
                $xml.Task.Settings.Priority="4"
                $xml.Save($taskFile)
                schtasks /CREATE /TN 'Boxstarter Task' /RU "$($Credential.UserName)" /IT /RP $Credential.GetNetworkCredential().Password /XML "$taskFile" /F | Out-Null
                schtasks /DELETE /TN 'Temp Boxstarter Task' /F | Out-Null
            }
            elseif(!((schtasks /QUERY /TN 'Boxstarter Task' /FO LIST 2>&1) -contains 'Logon Mode:    Interactive/Background')) { #For testing
                schtasks /CREATE /TN 'Boxstarter Task' /SC WEEKLY /RL HIGHEST `
                        /RU "$($Credential.UserName)" /IT `
                /TR "powershell -noprofile -ExecutionPolicy Bypass -File $env:temp\BoxstarterTask.ps1" /F |
                        Out-Null
            }
        }
        if($LastExitCode -gt 0){
            throw "Unable to create scheduled task as $($Credential.UserName)"
        }
    }
  • tools\Boxstarter.Common\en-US\about_boxstarter_logging.help.txt Show
    TOPIC
    	About_Boxstarter_Logging
    
    SYNOPSIS
    	Describes how to the different Boxstarter Logging functions to log to 
    	the console, log file or both.
    
    DESCRIPTION
    	Boxstarter provides several logging logging functions to make it easy 
    	to deliver messages to script consumers and provide detailed debugging
    	information to log files. Here is a description of each of these 
    	functions:
    
    	Write-BoxstarterMessage
    		Writes a message to both the Boxstarter log file and to the screen. 
    		These messages are output in Green to make them stand out from 
    		other messages.
    
    	Log-BoxstarterMessage
    		Only writes a message to the Boxstarter log file. The message is 
    		not logged to the console.
    
    	Out-BoxtarterLog
    		This is identical to Write-BoxstarterMessage but the text written 
    		to the screen is not in green. It is formatted normally.
    
    	Enter-BoxstarterLogable
    		This executes a script block and redirects the standard output 
    		stream and standard error stream to both the console and the 
    		Boxstarter log file. This is similar to Out-Boxstarterlog but it 
    		includes the output from standard command line utilities.
    
    	Start-TimedSection and Stop-TimedSection
    		These functions surround all script in between the start and end 
    		functions with a header and footer message and time the script 
    		execution. The footer message includes the total elapsed time. 
    		These sections can be nested.
    
    SEE ALSO
    
    	http://boxstarter.org
    	Write-BoxstarterMessage
    	Out-BoxtarterLog
    	Enter-BoxstarterLogable
    	Start-TimedSection
    	Stop-TimedSection
    
  • tools\Boxstarter.Common\Enter-DotNet4.ps1 Show
    function Enter-Dotnet4 {
    <#
    .SYNOPSIS
    Runs a script from a process hosting the .net 4 runtile
    
    .DESCRIPTION
    This function will ensure that the .net 4 runtime is installed on the
    machine. If it is not, it will be downloaded and installed. If running
    remotely, the .net 4 installation will run from a scheduled task.
    
    If the CLRVersion of the hosting powershell process is less than 4,
    such as is the case in powershell 2, the given script will be run
    from a new a new powershell process tht will be configured to host the
    CLRVersion 4.0.30319.
    
    .Parameter ScriptBlock
    The script to be executed in the .net 4 CLR
    
    .Parameter ArgumentList
    Arguments to be passed to the ScriptBlock
    
    .LINK
    http://boxstarter.org
    
    #>
        param(
            [ScriptBlock]$ScriptBlock,
            [object[]]$ArgumentList
        )
        Enable-Net40
        if($PSVersionTable.CLRVersion.Major -lt 4) {
            Write-BoxstarterMessage "Relaunching powershell under .net fx v4" -verbose
            $env:COMPLUS_version="v4.0.30319"
            & powershell -OutputFormat Text -ExecutionPolicy bypass -command $ScriptBlock -args $ArgumentList
        }
        else {
            Write-BoxstarterMessage "Using current powershell..." -verbose
            Invoke-Command -ScriptBlock $ScriptBlock -argumentlist $ArgumentList
        }
    }
    
    function Is64Bit {  [IntPtr]::Size -eq 8  }
    
    function Enable-Net40 {
        if(Is64Bit) {$fx="framework64"} else {$fx="framework"}
        if(!(test-path "$env:windir\Microsoft.Net\$fx\v4.0.30319")) {
            if((Test-PendingReboot) -and $Boxstarter.RebootOk) {return Invoke-Reboot}
            Write-BoxstarterMessage "Downloading .net 4.5..."
            Get-HttpResource "http://download.microsoft.com/download/b/a/4/ba4a7e71-2906-4b2d-a0e1-80cf16844f5f/dotnetfx45_full_x86_x64.exe" "$env:temp\net45.exe"
            Write-BoxstarterMessage "Installing .net 4.5..."
            if(Get-IsRemote) {
                Invoke-FromTask @"
    Start-Process "$env:temp\net45.exe" -verb runas -wait -argumentList "/quiet /norestart /log $env:temp\net45.log"
    "@
            }
            else {
                $proc = Start-Process "$env:temp\net45.exe" -verb runas -argumentList "/quiet /norestart /log $env:temp\net45.log" -PassThru 
                while(!$proc.HasExited){ sleep -Seconds 1 }
            }
        }
    }
    
  • tools\Boxstarter.Common\Format-BoxStarterMessage.ps1 Show
    function Format-BoxStarterMessage {
        param($BoxStarterMessage)
            if(Get-IsRemote){
            $BoxStarterMessage = "[$env:Computername]$BoxStarterMessage"
        }
        return $BoxStarterMessage
    }
  • tools\Boxstarter.Common\Get-CurrentUser.ps1 Show
    function Get-CurrentUser {
    <#
    .SYNOPSIS
    Returns the domain and username of the currently logged in user.
    
    #>
        $identity  = [System.Security.Principal.WindowsIdentity]::GetCurrent()
        $parts = $identity.Name -split "\\"
        return @{Domain=$parts[0];Name=$parts[1]}
    }
  • tools\Boxstarter.Common\Get-HttpResource.ps1 Show
    function Get-HttpResource {
    <#
    .SYNOPSIS
    Downloads the contents from a URL
    
    .DESCRIPTION
    Get-HttpResource downloads the contents of an HTTP url.
    When -PassThru is specified it returns the string content.
    
    .PARAMETER Url
    The url containing the content to download.
    
    .PARAMETER OutputPath
    If provided, the content will be saved to this path.
    
    .PARAMETER PassThru
    If provided, the string will be output to the pipeline.
    
    .EXAMPLE
    $content = Get-HttpResource -Url 'http://my/url' `
                                -OutputPath 'c:\myfile.txt' `
                                -PassThru
    
    This downloads the content located at http://my/url and
    saves it to a file at c:\myfile.txt and also returns
    the downloaded string.
    
    .LINK
    http://boxstarter.org
    
    #>
        param (
            [string]$Url,
            [string]$OutputPath = $null,
            [switch]$PassThru
        )
        Write-BoxstarterMessage "Downloading $url" -Verbose
        $str = Invoke-RetriableScript -RetryScript {
            $downloader=new-object net.webclient
            $wp=[system.net.WebProxy]::GetDefaultProxy()
            $wp.UseDefaultCredentials=$true
            $downloader.Proxy=$wp
            $downloader.UseDefaultCredentials=$true
            try {
                if($args[1]) {
                    Write-BoxstarterMessage "Saving $($args[0]) to $($args[1])" -Verbose
                    $downloader.DownloadFile($args[0], $args[1])
                }
                else {
                    $downloader.DownloadString($args[0])
                }
            }
            catch{
                if($VerbosePreference -eq "Continue"){
                    Write-Error $($_.Exception | fl * -Force | Out-String)
                }
                throw $_
            }
        } $Url $OutputPath
    
        if($PassThru) { 
            if($str) {
                Write-Output $str
            }
            elseif($OutputPath) {
                Get-Content -Path $OutputPath
            }
        }
    }
    
  • tools\Boxstarter.Common\Get-IsMicrosoftUpdateEnabled.ps1 Show
    function Get-IsMicrosoftUpdateEnabled {
    <#
    .SYNOPSIS
    Returns $True if Microsoft Update is currently enabled
    
    .LINK
    http://boxstarter.org
    
    #>    
    	# Default response to false, unless proven otherwise
    	$installed = $false
    
    	$serviceManager = New-Object -ComObject Microsoft.Update.ServiceManager -Strict
    	$serviceManager.ClientApplicationID = "Boxstarter"
    
    	foreach ($service in $serviceManager.Services) {
    		if( $service.Name -eq "Microsoft Update") {
    			$installed = $true;  
    			break;
    		} 
    	}
    	
    	return $installed
    }
  • tools\Boxstarter.Common\Get-IsRemote.ps1 Show
    function Get-IsRemote {
    param (
        [switch]$PowershellRemoting
    )
    <#
    .SYNOPSIS
    Returns $True if the current PowerShell session is running remotely
    
    .LINK
    http://boxstarter.org
    
    #>    
        if($PSSenderInfo -ne $null) {return $true}
        if($PowershellRemoting) {return $false}
        if($env:IsRemote -ne $null) { return [bool]::Parse($env:IsRemote) }
        else {
            $script:recursionLevel = 0
            $env:IsRemote = Test-ChildOfWinrs
            return [bool]::Parse($env:IsRemote)
        }
    }
    
    function Test-ChildOfWinrs($ID = $PID) {
       if(++$script:recursionLevel -gt 20) { return $false }
       $parent = (Get-WmiObject -Class Win32_Process -Filter "ProcessID=$ID").ParentProcessID 
        if($parent -eq $null) { 
            Log-BoxstarterMessage "No parent process found. Must be root."
            return $false 
        } 
        else {
        	try {$parentProc = Get-Process -ID $parent -ErrorAction Stop} catch {
                Log-BoxstarterMessage "Error getting parent process"
                $global:error.RemoveAt(0)
                return $false
            }
            Log-BoxstarterMessage "parent process is $($parentProc.Name)"
        	
            if(@('wsmprovhost','winrshost') -Contains $parentProc.Name) {return $true}
            elseif($parentProc.Name -eq "services") {return $false} 
        	else {
        		return Test-ChildOfWinrs $parent
        	}
        }
    } 
  • tools\Boxstarter.Common\Init-Settings.ps1 Show
    if(!$Global:Boxstarter) { 
        $Global:Boxstarter = @{} 
        $Boxstarter.SuppressLogging=$false
    }
    $Boxstarter.BaseDir=(Split-Path -parent ((Get-Item $PSScriptRoot).FullName))
    
    
  • tools\Boxstarter.Common\Invoke-FromTask.ps1 Show
    function Invoke-FromTask {
    <#
    .SYNOPSIS
    Invokes a command inside of a scheduled task
    
    .DESCRIPTION
    This invokes the boxstarter scheduled task. 
    The task is run in an elevated session using the provided 
    credentials. If the processes started by the task become idle for 
    more that the specified timeout, the task will be terminated. All 
    output and any errors from the task will be streamed to the calling 
    session. 
    
     .PARAMETER Command
     The command to run in the task.
    
    .PARAMETER IdleTimeout
    The number of seconds after which the task will be terminated if it 
    becomes idle. The value 0 is an indefinite timeout and 120 is the 
    default.
    
    .PARAMETER TotalTimeout
    The number of seconds after which the task will be terminated whether
    it is idle or active.
    
    .EXAMPLE
    Invoke-FromTask Install-WindowsUpdate -AcceptEula
    
    This will install Windows Updates in a scheduled task
    
    .EXAMPLE
    Invoke-FromTask "DISM /Online /NoRestart /Enable-Feature:TelnetClient" -IdleTimeout 20
    
    This will use DISM.exe to install the telnet client and will kill 
    the task if it becomes idle for more that 20 seconds.
    
    .LINK
    http://boxstarter.org
    Create-BoxstarterTask
    Remove-BoxstarterTask
    #>
        param(
            $command,
            $DotNetVersion = $null,
            $idleTimeout=120,
            $totalTimeout=3600
        )
        Write-BoxstarterMessage "Invoking $command in scheduled task" -Verbose
        $runningCommand = Add-TaskFiles $command $DotNetVersion
    
        $taskProc = start-Task $runningCommand
    
        if($taskProc -ne $null){
            Write-BoxstarterMessage "Command launched in process $taskProc" -Verbose
            try { 
                $waitProc=get-process -id $taskProc -ErrorAction Stop 
                Write-BoxstarterMessage "Waiting on $($waitProc.Id)" -Verbose
            } catch { $global:error.RemoveAt(0) }
        }
    
        try {
            Wait-ForTask $waitProc $idleTimeout $totalTimeout
        }
        catch {
            Write-BoxstarterMessage "error thrown managing task" -verbose
            Write-BoxstarterMessage "$($_ | fl * -force | out-string)" -verbose
            throw $_
        }
        Write-BoxstarterMessage "Task has completed" -Verbose
    
        $verboseStream = Get-CliXmlStream (Get-ErrorFileName) 'verbose'
        if($verboseStream -ne $null) {
            Write-BoxstarterMessage "Warnings and Verbose output from task:"
            $verboseStream | % { Write-Host $_ }
        }
    
        $errorStream = Get-CliXmlStream (Get-ErrorFileName) 'error'
        if($errorStream -ne $null -and $errorStream.length -gt 0) {
            throw $errorStream
        }
    }
    
    function Get-ErrorFileName { "$env:temp\BoxstarterError.stream" }
    
    function Get-CliXmlStream($cliXmlFile, $stream) {
        $content = get-content $cliXmlFile
        if($content.count -lt 2) { return $null }
    
        # Strip the first line containing '#< CLIXML'
        [xml]$xml = $content[1..($content.count-1)]
    
        # return stream stripping carriage retuens and linefeeds
        $xml.DocumentElement.ChildNodes |
          ? { $_.S -eq $stream } |
          % { $_.'#text'.Replace('_x000D_','').Replace('_x000A_','') } |
          out-string
    }
    
    function Get-ChildProcessMemoryUsage {
        param(
            $ID=$PID,
            [int]$res=0
        )
        Get-WmiObject -Class Win32_Process -Filter "ParentProcessID=$ID" | % { 
            if($_.ProcessID -ne $null) {
                try {
                    $proc = Get-Process -ID $_.ProcessID -ErrorAction Stop
                    Write-BoxstarterMessage "$($_.Name) $($proc.PrivateMemorySize + $proc.WorkingSet)" -Verbose
                    $res += $proc.PrivateMemorySize + $proc.WorkingSet
                    $res += (Get-ChildProcessMemoryUsage $_.ProcessID $res)
                } catch { $global:error.RemoveAt(0) }
            }
        }
        $res
    }
    
    function Add-TaskFiles($command, $DotNetVersion) {
        $encoded = [Convert]::ToBase64String([System.Text.Encoding]::Unicode.GetBytes("`$ProgressPreference='SilentlyContinue';$command"))
        [email protected]"
    $(if($DotNetVersion -ne $null){"`$env:COMPLUS_version='$DotNetVersion'"})
    Start-Process powershell -NoNewWindow -Wait -RedirectStandardError $(Get-ErrorFileName) -RedirectStandardOutput $env:temp\BoxstarterOutput.stream -WorkingDirectory '$PWD' -ArgumentList "-noprofile -ExecutionPolicy Bypass -EncodedCommand $encoded"
    Remove-Item $env:temp\BoxstarterTask.ps1 -ErrorAction SilentlyContinue
    "@
        Set-Content $env:temp\BoxstarterTask.ps1 -value $fileContent -force
        new-Item $env:temp\BoxstarterOutput.stream -Type File -Force | out-null
        new-Item (Get-ErrorFileName) -Type File -Force | out-null
        $encoded
    }
    
    function start-Task($encoded){
        [email protected]()
        $tasks+=gwmi Win32_Process -Filter "name = 'powershell.exe' and CommandLine like '%$encoded%'" | select ProcessId | % { $_.ProcessId }
        Write-BoxstarterMessage "Found $($tasks.Length) tasks already running" -Verbose
        $taskResult = schtasks /RUN /I /TN 'Boxstarter Task'
        if($LastExitCode -gt 0){
            throw "Unable to run scheduled task. Message from task was $taskResult"
        }
        Write-BoxstarterMessage "Launched task. Waiting for task to launch command..." -Verbose
        do{
            if(!(Test-Path $env:temp\BoxstarterTask.ps1)){
                Write-BoxstarterMessage "Task Completed before its process was captured." -Verbose
                break
            }
            $taskProc=gwmi Win32_Process -Filter "name = 'powershell.exe' and CommandLine like '%$encoded%'" | select ProcessId | % { $_.ProcessId } | ? { !($tasks -contains $_) }
    
            Start-Sleep -Second 1
        }
        Until($taskProc -ne $null)
    
        return $taskProc
    }
    
    function Test-TaskTimeout($waitProc, $idleTimeout) {
        if($memUsageStack -eq $null){
            $script:memUsageStack=New-Object -TypeName System.Collections.Stack
        }
        if($idleTimeout -gt 0){
            $lastMemUsageCount=Get-ChildProcessMemoryUsage $waitProc.ID
            Write-BoxstarterMessage "Memory read: $lastMemUsageCount" -Verbose
            Write-BoxstarterMessage "Memory count: $($memUsageStack.Count)" -Verbose
            $memUsageStack.Push($lastMemUsageCount)
            if($lastMemUsageCount -eq 0 -or (($memUsageStack.ToArray() | ? { $_ -ne $lastMemUsageCount }) -ne $null)){
                $memUsageStack.Clear()
            }
            if($memUsageStack.Count -gt $idleTimeout){
                Write-BoxstarterMessage "Task has exceeded its timeout with no activity. Killing task..."
                KillTree $waitProc.ID
                throw "TASK:`r`n$command`r`n`r`nIs likely in a hung state."
            }
        }
        Start-Sleep -Second 1
    }
    
    function Wait-ForTask($waitProc, $idleTimeout, $totalTimeout){
        $reader=New-Object -TypeName System.IO.FileStream -ArgumentList @(
            "$env:temp\BoxstarterOutput.Stream",
            [system.io.filemode]::Open,[System.io.FileAccess]::ReadWrite,
            [System.IO.FileShare]::ReadWrite)
        try{
            $procStartTime = $waitProc.StartTime
            while($waitProc -ne $null -and !($waitProc.HasExited)) {
                $timeTaken = [DateTime]::Now.Subtract($procStartTime)
                if($totalTimeout -gt 0 -and $timeTaken.TotalSeconds -gt $totalTimeout){
                    Write-BoxstarterMessage "Task has exceeded its total timeout. Killing task..."
                    KillTree $waitProc.ID
                    throw "TASK:`r`n$command`r`n`r`nIs likely in a hung state."
                }
    
                $byte = New-Object Byte[] 100
                $count=$reader.Read($byte,0,100)
                if($count -ne 0){
                    $text = [System.Text.Encoding]::Default.GetString($byte,0,$count)
                    $text | Write-Host -NoNewline
                }
                else {
                    Test-TaskTimeout $waitProc $idleTimeout
                }
            }
            Start-Sleep -Second 1
            Write-BoxstarterMessage "Proc has exited: $($waitProc.HasExited) or Is Null: $($waitProc -eq $null)" -Verbose
            $byte=$reader.ReadByte()
            $text=$null
            while($byte -ne -1){
                $text += [System.Text.Encoding]::Default.GetString($byte)
                $byte=$reader.ReadByte()
            }
            if($text -ne $null){
                $text | write-host -NoNewline
            }
        }
        finally{
            $reader.Dispose()
            if($waitProc -ne $null -and !$waitProc.HasExited){
                KillTree $waitProc.ID
            }
        }    
    }
    
    function KillTree($id){
        Get-WmiObject -Class Win32_Process -Filter "ParentProcessID=$ID" | % { 
            if($_.ProcessID -ne $null) {
                Invoke-SilentKill $_.ProcessID
                Write-BoxstarterMessage "Killing $($_.Name)" -Verbose
                KillTree $_.ProcessID
            }
        }
        Invoke-SilentKill $id -wait
    }
    
    function Invoke-SilentKill($id, [switch]$wait) {
        try {
            $p = Kill $id -ErrorAction Stop -Force
            if($wait) {
                while($p -ne $null -and !$p.HasExited){
                    Start-Sleep 1
                }
            }
        } 
        catch {
            $global:error.RemoveAt(0)
        }
    }
    
  • tools\Boxstarter.Common\Invoke-RetriableScript.ps1 Show
    function Invoke-RetriableScript{
    <#
    .SYNOPSIS
    Retries a script 5 times or until it completes without terminating errors. 
    All Unnamed arguments will be passed as arguments to the script
    #>
        param([ScriptBlock]$RetryScript)
        $currentErrorAction=$ErrorActionPreference
        try{
            $ErrorActionPreference = "Stop"
            for($count = 1; $count -le 5; $count++) {
                try {
                    Write-BoxstarterMessage "Attempt #$count..." -Verbose
                    $ret = Invoke-Command -ScriptBlock $RetryScript -ArgumentList $args
                    return $ret
                    break
                }
                catch {
                    if($global:Error.Count -gt 0){$global:Error.RemoveAt(0)}
                    if($count -eq 5) { throw $_ }
                    else { Sleep 10 }
                }
            }
        }
        finally{
            $ErrorActionPreference = $currentErrorAction
        }
    }
  • tools\Boxstarter.Common\Log-BoxStarterMessage.ps1 Show
    function Log-BoxStarterMessage {
    <#
    .SYNOPSIS
    Logs a message to the Boxstarter Log File
    
    .DESCRIPTION
    Logs a message to the log. The message does not render on the 
    console. Boxstarter timestamps the log message so that the file 
    entry has the time the message was written. The log is located at 
    $Boxstarter.Log.
    
    .Parameter Message
    The message to be logged.
    
    .LINK
    http://boxstarter.org
    about_boxstarter_logging
    
    #>
        param([object[]]$message)
        if($Boxstarter.Log) {
            $fileStream = New-Object -TypeName System.IO.FileStream -ArgumentList @(
                $Boxstarter.Log,
                [system.io.filemode]::Append,
                [System.io.FileAccess]::Write,
                [System.IO.FileShare]::ReadWrite
            )
            $writer = New-Object -TypeName System.IO.StreamWriter -ArgumentList @(
                $fileStream,
                [System.Text.Encoding]::UTF8
            )
            try {
                $writer.WriteLine("[$(Get-Date -format o):::PID $pid] $message")
            }
            finally{
                $writer.Dispose()
            }
        }
    }
  • tools\Boxstarter.Common\Out-BoxstarterLog.ps1 Show
    function Enter-BoxstarterLogable{
    <#
    .SYNOPSIS
    Logs the output and error streams of the script to the 
    console and Boxstarter log.
    
    .DESCRIPTION
    Boxstarter runs the provided script and redirects the 
    standard output and standard error streams to the host
    console and to the Boxstarter log. This will include both
    PowerShell write-output and errors as well as the output
    from any standard command line executables that use 
    standard output and error streams.
    
    .PARAMETER script
    The script to execute.
    
    .EXAMPLE
    Enter-BoxstarterLogable{
        Get-Process Chrome
        Netstat
    }
    
    This sends both the out put of the PowerShell Get-Process
    cmdlet and the Netstat command line utility to the screen
    as well as th boxstarter log.
    
    .LINK
    http://boxstarter.org
    about_boxstarter_logging
    
    #>
        param([ScriptBlock] $script)
    
        & ($script) 2>&1 | Out-BoxstarterLog
    }
    
    function Out-BoxstarterLog {
    <#
    .SYNOPSIS
    Logs provided text or objects to the console and 
    Boxstarter log.
    
    .DESCRIPTION
    This is essentially identical to Tee-Object with the PS 3.0
    only parameter -Append. This will work in either PS 2.0 or
    PS 3.0.
    
    .PARAMETER object
    Object to log.
    
    .EXAMPLE
    Out-BoxstarterLog "This can be seen on the screen and in the log file"
    
    .EXAMPLE
    "This can be seen on the screen and in the log file" | Out-BoxstarterLog
    
    .LINK
    http://boxstarter.org
    about_boxstarter_logging
    
    #>    
        param(
            [Parameter(position=0,ValueFromPipeline=$True)]
            [object]$object,
            [switch]$Quiet
        )
    
        process {
            if(!$Quiet -and !$Boxstarter.SuppressLogging){write-host $object}
            if($object){
                Log-BoxstarterMessage $object
            }
        }
    }
    
  • tools\Boxstarter.Common\Remove-BoxstarterError.ps1 Show
    function Remove-BoxstarterError {
    <#
    .SYNOPSIS
    Removes errors from the error collection that occur within a block.
    
    #>    
        param([ScriptBlock]$block)
    
        $currentErrorAction=$Global:ErrorActionPreference
        $currentErrorCount = $Global:Error.Count
        
        try{
            $Global:ErrorActionPreference = "SilentlyContinue"
            Invoke-Command -ScriptBlock $block
    
            while($Global:Error.Count -gt $currentErrorCount){
                $Global:Error.RemoveAt(0)
            }
        }
        finally{
            $Global:ErrorActionPreference = $currentErrorAction
        }
    }
  • tools\Boxstarter.Common\Remove-BoxstarterTask.ps1 Show
    function Remove-BoxstarterTask {
    <#
    .SYNOPSIS
    Deletes the Boxstarter task.
    
    .DESCRIPTION
    Deletes the Boxstarter task. Boxstarter calls this when an 
    installation session completes.
    
    .LINK
    http://boxstarter.org
    Create-BoxstarterTask
    Invoke-BoxstarterTask
    
    #>    
        Write-BoxstarterMessage "Removing Boxstarter Scheduled Task..." -Verbose
    	
        Remove-BoxstarterError {
            $result = schtasks /DELETE /TN 'Boxstarter Task' /F 2>&1
            Write-BoxstarterMessage "Removed Boxstarter Scheduled Task with this result: $result" -Verbose
        }
    }
    
  • tools\Boxstarter.Common\Start-TimedSection.ps1 Show
    function Start-TimedSection {
    <#
    .SYNOPSIS
    Begins a timed section
    
    .DESCRIPTION
    A timed section is a portion of script that is timed. Used 
    with Stop-TimedSection, the beginning and end of the section 
    are logged to both the console and the log along with the 
    amount of time elapsed.
    
    The function returns a guid that is used to identify the 
    section when stopping it.
    
    .PARAMETER SectionName
    The Title or Label of the section being timed. This string 
    is used in the logging to identify the section.
    
    .PARAMETER Verbose
    Instructs Start-TimedSection to write to the Verbose stream. Although 
    this will always log messages to the Boxstarter log, it will only log 
    to the console if the session's VerbosePreference is set to capture 
    the Verbose stream or the -Verbose switch was set when calling
    Install-BoxstarterPackage.
    
    .EXAMPLE
    $session=Start-TimedSection "My First Section"
    Stop-TimedSection $session
    
    This creates a block as follows:
    
    + Boxstarter starting My First Section
    
    Some stuff happens here.
    
    + Boxstarter finished My First Section 00:00:00.2074282
    
    .EXAMPLE
    Timed Sections can be nested or staggered. You can have 
    multiple sections running at once.
    
    $session=Start-TimedSection "My First Section"
    $innerSession=Start-TimedSection "My Inner Section"
    Stop-TimedSection $innerSession
    Stop-TimedSection $session
    
    This creates a block as follows:
    
    + Boxstarter starting My First Section
    
    Some stuff happens here.
    
    ++ Boxstarter starting My Inner Section
    
    Some inner stuff happens here.
    
    ++ Boxstarter finished My Inner Section 00:00:00.1074282
    
    Some more stuff happens here.
    
    + Boxstarter finished My First Section 00:00:00.2074282
    
    Note that the number of '+' chars indicate nesting level.
    
    .EXAMPLE
    $session=Start-TimedSection "My First Section" -Verbose
    Stop-TimedSection $session
    
    This will write the start and finish messages to the 
    Boxstarter log but will not write to the console unless the 
    user has the the VerbosePreference variable or used the 
    Verbose switch of Install-BoxstarterPackage.
    
    .NOTES
    If the SuppressLogging setting of the $Boxstarter variable is true, 
    logging messages will be suppressed and not sent to the console or the 
    log.
    
    .LINK
    http://boxstarter.org
    Stop-TimedSection
    about_boxstarter_logging
    #>
        param(
            [string]$sectionName,
            [switch]$Verbose)
        $stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
        $guid = [guid]::NewGuid().ToString()
        [email protected]{title=$sectionName;stopwatch=$stopwatch;verbose=$Verbose}
        if(!$script:boxstarterTimers) {$script:[email protected]{}}
        $boxstarterTimers.$guid=$timerEntry
        $padCars="".PadLeft($boxstarterTimers.Count,"+")
        Write-BoxstarterMessage "$padCars Boxstarter starting $sectionName" -NoLogo -Verbose:$Verbose
        return $guid
    }
  • tools\Boxstarter.Common\Stop-TimedSection.ps1 Show
    function Stop-TimedSection {
    <#
    .SYNOPSIS
    Ends a timed section
    
    .DESCRIPTION
    A timed section is a portion of script that is timed. Used 
    with Start-TimedSection, the beginning and end of the section 
    are logged to both the console and the log along with the 
    amount of time elapsed.
    
    .PARAMETER SectionId
    The guid that was generated by Start-TimedSection and 
    identifies which section is ending.
    
    .EXAMPLE
    $session=Start-TimedSection "My First Section"
    Stop-TimedSection $session
    
    This creates a block as follows:
    
    + Boxstarter starting My First Section
    
    Some stuff happens here.
    
    + Boxstarter finished My First Section 00:00:00.2074282
    
    .EXAMPLE
    Timed Sections can be nested or staggered. You can have 
    multiple sections running at once.
    
    $session=Start-TimedSection "My First Section"
    $innerSession=Start-TimedSection "My Inner Section"
    Stop-TimedSection $innerSession
    Stop-TimedSection $session
    
    This creates a block as follows:
    
    + Boxstarter starting My First Section
    
    Some stuff happens here.
    
    ++ Boxstarter starting My Inner Section
    
    Some inner stuff happens here.
    
    ++ Boxstarter finished My Inner Section 00:00:00.1074282
    
    Some more stuff happens here.
    
    + Boxstarter finished My First Section 00:00:00.2074282
    
    Note that the number of '+' chars indicate nesting level.
    
    .LINK
    http://boxstarter.org
    Start-TimedSection
    about_boxstarter_logging
    
    #>
        param([string]$SectionId)
        $timerEntry=$script:boxstarterTimers.$SectionId
        if(!$timerEntry){return}
        $padCars="".PadLeft($boxstarterTimers.Count,"+")
        $script:boxstarterTimers.Remove($SectionId)
        $stopwatch = $timerEntry.stopwatch
        Write-BoxstarterMessage "$padCars Boxstarter finished $($timerEntry.Title) $($stopwatch.Elapsed.ToString())" -NoLogo -Verbose:$timerEntry.Verbose
        $stopwatch.Stop()
    }
  • tools\Boxstarter.Common\Test-Admin.ps1 Show
    function Test-Admin {
    <#
    .SYNOPSIS
    Determines if the console is elevated
    
    #>
        $identity  = [System.Security.Principal.WindowsIdentity]::GetCurrent()
        $principal = New-Object System.Security.Principal.WindowsPrincipal( $identity )
        return $principal.IsInRole( [System.Security.Principal.WindowsBuiltInRole]::Administrator )
    }
    
    
  • tools\Boxstarter.Common\Write-BoxstarterLogo.ps1 Show
    function Write-BoxstarterLogo {
        $boxMod=(IEX (Get-Content (join-path $Boxstarter.Basedir Boxstarter.Common\Boxstarter.Common.psd1) | Out-String))
        write-BoxstarterMessage "Boxstarter Version $($boxMod.ModuleVersion)" -nologo -Color White
        write-BoxstarterMessage "$($boxMod.Copyright) http://boxstarter.org`r`n" -nologo -Color White
    }
  • tools\Boxstarter.Common\Write-BoxstarterMessage.ps1 Show
    function Write-BoxstarterMessage {
    <#
    .SYNOPSIS
    Writes a message to the console and the log
    
    .DESCRIPTION
    Formats the message in green. This message is also logged to the 
    Boxstarter log file with a timestamp.
    
    .PARAMETER Message
    The string to be logged
    
    .PARAMETER NoLogo
    If omitted, the message will be preceded with "Boxstarter: "
    
    .PARAMETER Color
    Specifies a foreground color to use for the message. Green is the 
    default.
    
    .PARAMETER Verbose
    Instructs Write-Boxstarter to write to the Verbose stream. Although 
    this will always log messages to the Boxstarter log, it will only log 
    to the console if the session's VerbosePreference is set to capture 
    the Verbose stream or the -Verbose switch was set when calling
    Install-BoxstarterPackage.
    
    .EXAMPLE
    Write-BoxstarterMessage "I am logging a message."
    
    This creates the following console output:
    Boxstarter: I am Logging a Message
    
    This will appear in the log:
    [2013-02-11T00:59:44.9768457-08:00] Boxstarter: I am Logging a Message
    
    .EXAMPLE
    Write-BoxstarterMessage "I am logging a message." -Verbose
    
    This outputs to the console via the Verbose stream if the session's 
    VerbosePreference is set to capture the Verbose stream or the 
    -Verbose switch was set when calling Install-BoxstarterPackage.
    
    This will appear in the log:
    [2013-02-11T00:59:44.9768457-08:00] Boxstarter: I am Logging a Message
    
    .NOTES
    If the SuppressLogging setting of the $Boxstarter variable is true, 
    logging messages will be suppressed and not sent to the console or the 
    log.
    
    .LINK
    http://boxstarter.org
    about_boxstarter_logging
    
    #>
        param(
            [String]$message, 
            [switch]$nologo,
            [ConsoleColor]$color=[ConsoleColor]::green,
            [switch]$Verbose
        )
        if($global:Boxstarter.ProgressArgs -and !$Verbose) {
            $a=$global:Boxstarter.ProgressArgs
            Write-Progress @a -CurrentOperation $message 
        }
        if(!$nologo){$message = "Boxstarter: $message"}
        $fmtTitle = Format-BoxStarterMessage $message
        Log-BoxstarterMessage $fmtTitle
        if($Verbose){
            Write-Verbose $fmtTitle
        }
        else {
            #Boxstarter has a Write-host proxy function and it ensures all is logged
            if(!$Boxstarter.SuppressLogging){Write-Host $fmtTitle -ForeGroundColor $color}
        }
    }
  • tools\chocolateyinstall.ps1 Show
    $tools = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
    . (Join-Path $tools Setup.ps1)
    try { 
        $ModuleName = (Get-ChildItem $tools | ?{ $_.PSIsContainer }).BaseName
        $preInstall = Join-Path $tools "$modulename.preinstall.ps1"
        if(Test-Path $preInstall) { .$preInstall }
        Install-Boxstarter $tools $ModuleName $env:chocolateyPackageParameters
    } catch {
        write-output $_ | fl * -force
        throw $_.Exception
    }
  • tools\LICENSE.txt Show
                                     Apache License
                               Version 2.0, January 2004
                            http://www.apache.org/licenses/
    
       TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
    
       1. Definitions.
    
          "License" shall mean the terms and conditions for use, reproduction,
          and distribution as defined by Sections 1 through 9 of this document.
    
          "Licensor" shall mean the copyright owner or entity authorized by
          the copyright owner that is granting the License.
    
          "Legal Entity" shall mean the union of the acting entity and all
          other entities that control, are controlled by, or are under common
          control with that entity. For the purposes of this definition,
          "control" means (i) the power, direct or indirect, to cause the
          direction or management of such entity, whether by contract or
          otherwise, or (ii) ownership of fifty percent (50%) or more of the
          outstanding shares, or (iii) beneficial ownership of such entity.
    
          "You" (or "Your") shall mean an individual or Legal Entity
          exercising permissions granted by this License.
    
          "Source" form shall mean the preferred form for making modifications,
          including but not limited to software source code, documentation
          source, and configuration files.
    
          "Object" form shall mean any form resulting from mechanical
          transformation or translation of a Source form, including but
          not limited to compiled object code, generated documentation,
          and conversions to other media types.
    
          "Work" shall mean the work of authorship, whether in Source or
          Object form, made available under the License, as indicated by a
          copyright notice that is included in or attached to the work
          (an example is provided in the Appendix below).
    
          "Derivative Works" shall mean any work, whether in Source or Object
          form, that is based on (or derived from) the Work and for which the
          editorial revisions, annotations, elaborations, or other modifications
          represent, as a whole, an original work of authorship. For the purposes
          of this License, Derivative Works shall not include works that remain
          separable from, or merely link (or bind by name) to the interfaces of,
          the Work and Derivative Works thereof.
    
          "Contribution" shall mean any work of authorship, including
          the original version of the Work and any modifications or additions
          to that Work or Derivative Works thereof, that is intentionally
          submitted to Licensor for inclusion in the Work by the copyright owner
          or by an individual or Legal Entity authorized to submit on behalf of
          the copyright owner. For the purposes of this definition, "submitted"
          means any form of electronic, verbal, or written communication sent
          to the Licensor or its representatives, including but not limited to
          communication on electronic mailing lists, source code control systems,
          and issue tracking systems that are managed by, or on behalf of, the
          Licensor for the purpose of discussing and improving the Work, but
          excluding communication that is conspicuously marked or otherwise
          designated in writing by the copyright owner as "Not a Contribution."
    
          "Contributor" shall mean Licensor and any individual or Legal Entity
          on behalf of whom a Contribution has been received by Licensor and
          subsequently incorporated within the Work.
    
       2. Grant of Copyright License. Subject to the terms and conditions of
          this License, each Contributor hereby grants to You a perpetual,
          worldwide, non-exclusive, no-charge, royalty-free, irrevocable
          copyright license to reproduce, prepare Derivative Works of,
          publicly display, publicly perform, sublicense, and distribute the
          Work and such Derivative Works in Source or Object form.
    
       3. Grant of Patent License. Subject to the terms and conditions of
          this License, each Contributor hereby grants to You a perpetual,
          worldwide, non-exclusive, no-charge, royalty-free, irrevocable
          (except as stated in this section) patent license to make, have made,
          use, offer to sell, sell, import, and otherwise transfer the Work,
          where such license applies only to those patent claims licensable
          by such Contributor that are necessarily infringed by their
          Contribution(s) alone or by combination of their Contribution(s)
          with the Work to which such Contribution(s) was submitted. If You
          institute patent litigation against any entity (including a
          cross-claim or counterclaim in a lawsuit) alleging that the Work
          or a Contribution incorporated within the Work constitutes direct
          or contributory patent infringement, then any patent licenses
          granted to You under this License for that Work shall terminate
          as of the date such litigation is filed.
    
       4. Redistribution. You may reproduce and distribute copies of the
          Work or Derivative Works thereof in any medium, with or without
          modifications, and in Source or Object form, provided that You
          meet the following conditions:
    
          (a) You must give any other recipients of the Work or
              Derivative Works a copy of this License; and
    
          (b) You must cause any modified files to carry prominent notices
              stating that You changed the files; and
    
          (c) You must retain, in the Source form of any Derivative Works
              that You distribute, all copyright, patent, trademark, and
              attribution notices from the Source form of the Work,
              excluding those notices that do not pertain to any part of
              the Derivative Works; and
    
          (d) If the Work includes a "NOTICE" text file as part of its
              distribution, then any Derivative Works that You distribute must
              include a readable copy of the attribution notices contained
              within such NOTICE file, excluding those notices that do not
              pertain to any part of the Derivative Works, in at least one
              of the following places: within a NOTICE text file distributed
              as part of the Derivative Works; within the Source form or
              documentation, if provided along with the Derivative Works; or,
              within a display generated by the Derivative Works, if and
              wherever such third-party notices normally appear. The contents
              of the NOTICE file are for informational purposes only and
              do not modify the License. You may add Your own attribution
              notices within Derivative Works that You distribute, alongside
              or as an addendum to the NOTICE text from the Work, provided
              that such additional attribution notices cannot be construed
              as modifying the License.
    
          You may add Your own copyright statement to Your modifications and
          may provide additional or different license terms and conditions
          for use, reproduction, or distribution of Your modifications, or
          for any such Derivative Works as a whole, provided Your use,
          reproduction, and distribution of the Work otherwise complies with
          the conditions stated in this License.
    
       5. Submission of Contributions. Unless You explicitly state otherwise,
          any Contribution intentionally submitted for inclusion in the Work
          by You to the Licensor shall be under the terms and conditions of
          this License, without any additional terms or conditions.
          Notwithstanding the above, nothing herein shall supersede or modify
          the terms of any separate license agreement you may have executed
          with Licensor regarding such Contributions.
    
       6. Trademarks. This License does not grant permission to use the trade
          names, trademarks, service marks, or product names of the Licensor,
          except as required for reasonable and customary use in describing the
          origin of the Work and reproducing the content of the NOTICE file.
    
       7. Disclaimer of Warranty. Unless required by applicable law or
          agreed to in writing, Licensor provides the Work (and each
          Contributor provides its Contributions) on an "AS IS" BASIS,
          WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
          implied, including, without limitation, any warranties or conditions
          of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
          PARTICULAR PURPOSE. You are solely responsible for determining the
          appropriateness of using or redistributing the Work and assume any
          risks associated with Your exercise of permissions under this License.
    
       8. Limitation of Liability. In no event and under no legal theory,
          whether in tort (including negligence), contract, or otherwise,
          unless required by applicable law (such as deliberate and grossly
          negligent acts) or agreed to in writing, shall any Contributor be
          liable to You for damages, including any direct, indirect, special,
          incidental, or consequential damages of any character arising as a
          result of this License or out of the use or inability to use the
          Work (including but not limited to damages for loss of goodwill,
          work stoppage, computer failure or malfunction, or any and all
          other commercial damages or losses), even if such Contributor
          has been advised of the possibility of such damages.
    
       9. Accepting Warranty or Additional Liability. While redistributing
          the Work or Derivative Works thereof, You may choose to offer,
          and charge a fee for, acceptance of support, warranty, indemnity,
          or other liability obligations and/or rights consistent with this
          License. However, in accepting such obligations, You may act only
          on Your own behalf and on Your sole responsibility, not on behalf
          of any other Contributor, and only if You agree to indemnify,
          defend, and hold each Contributor harmless for any liability
          incurred by, or claims asserted against, such Contributor by reason
          of your accepting any such warranty or additional liability.
  • tools\setup.ps1 Show
    function Install-Boxstarter($here, $ModuleName, $installArgs = "") {
        $boxstarterPath=Join-Path $env:AppData Boxstarter
        if(!(test-Path $boxstarterPath)){
            mkdir $boxstarterPath
        }
        $packagePath=Join-Path $boxstarterPath BuildPackages
        if(!(test-Path $packagePath)){
            mkdir $packagePath
        }    
        foreach($ModulePath in (Get-ChildItem $here | ?{ $_.PSIsContainer })){
            $target=Join-Path $boxstarterPath $modulePath.BaseName
            if(test-Path $target){
                Remove-Item $target -Recurse -Force
            }
        }
        Copy-Item "$here\*" $boxstarterPath -Recurse -Force -Exclude ChocolateyInstall.ps1, Setup.*
    
        PersistBoxStarterPathToEnvironmentVariable "PSModulePath"
        PersistBoxStarterPathToEnvironmentVariable "Path"
        $binPath =  "$here\..\..\..\bin"
        $boxModule=Get-Module Boxstarter.Chocolatey
        if($boxModule) {
            if($boxModule.Path -like "$env:LOCALAPPDATA\Apps\*") {
                $clickonce=$true
            }
        }
        if(!$clickonce){
            Import-Module "$boxstarterPath\$ModuleName" -DisableNameChecking -Force -ErrorAction SilentlyContinue
        }
        $successMsg = @"
    The $ModuleName Module has been copied to $boxstarterPath and added to your Module path. 
    You will need to open a new console for the path to be visible.
    Use 'Get-Module Boxstarter.* -ListAvailable' to list all Boxstarter Modules.
    To list all available Boxstarter Commands, use:
    PS:>Import-Module $ModuleName
    PS:>Get-Command -Module Boxstarter.*
    
    To find more info visit http://Boxstarter.org or use:
    PS:>Import-Module $ModuleName
    PS:>Get-Help Boxstarter
    "@
        Write-Host $successMsg
    
        if($ModuleName -eq "Boxstarter.Chocolatey" -and !$env:appdata.StartsWith($env:windir)) {
            $desktop = $([System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::DesktopDirectory))
            $startMenu=$("$env:appdata\Microsoft\Windows\Start Menu\Programs\Boxstarter")
            if(!(Test-Path $startMenu)){
                mkdir $startMenu
            }
            $target="powershell.exe"
            $targetArgs="-ExecutionPolicy bypass -NoExit -Command `"&'$boxstarterPath\BoxstarterShell.ps1'`""
    
    		if($installArgs -inotcontains "nodesktopicon") {
    			$link = Join-Path $desktop "Boxstarter Shell.lnk"
    			Create-Shortcut $link $target $targetArgs $boxstarterPath
    		}
            $link = Join-Path $startMenu "Boxstarter Shell.lnk"
            Create-Shortcut $link $target $targetArgs $boxstarterPath
    
            Set-Content -Path "$binPath\BoxstarterShell.bat" -Force -Value "$target $TargetArgs"
        }
    }
    
    function Create-Shortcut($location, $target, $targetArgs, $boxstarterPath) {
        $wshshell = New-Object -ComObject WScript.Shell
        $lnk = $wshshell.CreateShortcut($location)
        $lnk.TargetPath = $target
        $lnk.Arguments = "$targetArgs"
        $lnk.WorkingDirectory = $boxstarterPath
        $lnk.IconLocation="$boxstarterPath\BoxLogo.ico"
        $lnk.Save()
    
    	$tempFile = "$env:temp\TempShortcut.lnk"
    		
    	$writer = new-object System.IO.FileStream $tempFile, ([System.IO.FileMode]::Create)
    	$reader = new-object System.IO.FileStream $location, ([System.IO.FileMode]::Open)
    		
    	while ($reader.Position -lt $reader.Length)
    	{		
    		$byte = $reader.ReadByte()
    		if ($reader.Position -eq 22) {
    			$byte = 34
    		}
    		$writer.WriteByte($byte)
    	}
    		
    	$reader.Close()
    	$writer.Close()
    				
    	Move-Item -Path $tempFile $location -Force
    }
    function PersistBoxStarterPathToEnvironmentVariable($variableName){
        $value = [Environment]::GetEnvironmentVariable($variableName, 'User')
        if($value){
            $values=($value -split ';' | ?{ !($_.ToLower() -match "\\boxstarter$")}) -join ';'
            $values+=";$boxstarterPath"
        } 
        elseif($variableName -eq "PSModulePath") {
            $values=[environment]::getfolderpath("mydocuments")
            $values +="\WindowsPowerShell\Modules;$boxstarterPath"
        }
        else {
            $values ="$boxstarterPath"
        }
        if(!$value -or !($values -contains $boxstarterPath)){
            $values = $values.Replace(';;',';')
            [Environment]::SetEnvironmentVariable($variableName, $values, 'User')
            $varValue = Get-Content env:\$variableName
            $varValue += ";$boxstarterPath"
            $varValue = $varValue.Replace(';;',';')
            Set-Content env:\$variableName -value $varValue
        }
    }

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

This package has no dependencies.

Package Maintainer(s)

Software Author(s)

  • Matt Wrock

Tags

Release Notes

  • Fix RebootOk setting always being set to false
  • Fix pending reboot check from always returning false
  • Persist RebootOk setting in nested installs
  • Suppress bogus Invalid Namespace errors
  • Added ability to configure "Expand to open folder" in Set-WindowsExplorerOptions
  • Added ability to configure QuickAccess options in Set-WindowsExplorerOption
  • Added Disable-GameBarTips to WinConfig module
  • Added Disable-BingSearch to WinConfig module
  • Updated to latest Get-PendingReboot
  • Eliminate multiple explorer restarts in Set-WindowsExplorerOption
  • Fix scenarios where providing multiple packages to Install-BoxstarterPackage fails
  • Added improved error logging where stacktrace was being dropped
  • Fix errors caused by using Int64 RebootCodes
  • Fix parameter typo in Set-ExplorerOptions
  • Update to latest Pester and ensure tests pass on clean VM

Version History

Version Downloads Last updated Status
Boxstarter Common Module 2.11.0 66396 Wednesday, May 16, 2018 approved
Boxstarter Common Module 2.10.3 54567 Thursday, July 27, 2017 approved
Boxstarter Common Module 2.9.27 2524 Wednesday, June 21, 2017 approved
Boxstarter Common Module 2.9.26 5353 Monday, June 19, 2017 approved
Boxstarter Common Module 2.9.24 548 Sunday, June 18, 2017 approved
Boxstarter Common Module 2.9.14 6769 Friday, May 5, 2017 approved
Show More

Discussion for the Boxstarter Common Module Package

Ground rules:

  • This discussion is only about Boxstarter Common Module and the Boxstarter Common Module package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Boxstarter Common Module, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok