├── .gitignore ├── LICENSE ├── PS-Framework ├── BaseScript.ps1 ├── BaseScript.xml ├── Updater.ps1 ├── Updater.xml ├── myExample.ps1 └── myExample.xml └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/launch.json 2 | PS-Framework/Updater.ps1.new -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /PS-Framework/BaseScript.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .NOTES 3 | =========================================================================== 4 | Created by: Markus Kraus 5 | Organization: mycloudrevolution.com 6 | Personal Blog: mycloudrevolution.com 7 | Twitter: @vMarkus_K 8 | =========================================================================== 9 | .DESCRIPTION 10 | This is a self updating PowerShell Script Framework. 11 | 12 | Module-Name: BaseScript 13 | Module Version: 1.1 14 | #> 15 | 16 | #region 1: Global Definitions 17 | $Validate = $True 18 | $BaseScriptXML = "BaseScript.xml" 19 | #endregion 20 | 21 | #region 2: Check and Load BaseXML 22 | $BaseScriptXMLPath = $BaseDir + $BaseScriptXML 23 | If (Test-Path $BaseXMLPath ) { 24 | try {$BaseScriptXMLContent = [XML] (Get-Content $BaseScriptXMLPath )} catch {$Validate = $false; Write-Error "`nERROR: Invalid $BaseScriptXML"} 25 | } Else { 26 | # Error out if loading fails 27 | $Validate = $false 28 | Write-Error "`nERROR: Cannot load $BaseScriptXML" 29 | } 30 | #endregion 31 | 32 | #region 3: Base Script Invokes 33 | if($Validate -eq $True) { 34 | [Array] $Scripts = $BaseScriptXMLContent.BaseScript.Scripts.Script 35 | Foreach($Script in $Scripts){ 36 | try { 37 | Write-Output "`nStarting $BaseDir$Script" 38 | Invoke-Expression ($BaseDir + $Script) 39 | } 40 | catch { 41 | # Error out if loading fails 42 | $Validate = $false 43 | Write-Error "`nERROR: Failed to Start $Script in $BaseDir" 44 | } 45 | } 46 | } 47 | #endregion 48 | 49 | #region 4: Finalize 50 | if($Validate -eq $false) { 51 | Write-Error "`nERROR: Validation Error(s) occured during Script!" 52 | } 53 | #endregion 54 | -------------------------------------------------------------------------------- /PS-Framework/BaseScript.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /PS-Framework/Updater.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .NOTES 3 | =========================================================================== 4 | Created by: Markus Kraus 5 | Organization: mycloudrevolution.com 6 | Personal Blog: mycloudrevolution.com 7 | Twitter: @vMarkus_K 8 | =========================================================================== 9 | .DESCRIPTION 10 | This is a self updating PowerShell Script Framework. 11 | 12 | Module-Name: Updater 13 | Module Version: 1.2 14 | #> 15 | [CmdletBinding()] 16 | Param( 17 | [Parameter(Mandatory=$False,Position=1)] 18 | [string] $Config = "Default", 19 | [Parameter(Mandatory=$False,Position=2)] 20 | [string] $IgnoreUpdate = $False 21 | ) 22 | 23 | #region: Clear Errors 24 | $error.clear() 25 | #endregion 26 | 27 | #region: Global Definitions 28 | $Validate = $True 29 | $BaseDir = $env:windir + "\TEMP\PS\" 30 | $LogFile = $BaseDir + "Output.txt" 31 | $BaseURL = "http://mycloudrevolution.com/Projects/PS-Framework/" 32 | $BaseXML = "Updater.xml" 33 | $BasePS1 = "Updater.ps1" 34 | Start-Transcript -Path $LogFile 35 | Write-Output "`nStarting with Config: $Config" 36 | #endregion 37 | 38 | #region: Check amd Create Path 39 | if (!(Test-Path -path $BaseDir)) { 40 | try { 41 | New-Item -ItemType directory -Path $BaseDir 42 | } 43 | catch { 44 | # Error out if loading fails 45 | $Validate = $false 46 | Write-Error "`nERROR: Failed to Create $BaseDir" 47 | } 48 | } 49 | #endregion 50 | 51 | #region: Download BaseXML 52 | try { 53 | $Url = $BaseURL + $BaseXML 54 | Invoke-WebRequest $Url -OutFile ($BaseDir + $BaseXML) -ErrorAction Stop 55 | } 56 | catch { 57 | # Error out if loading fails 58 | $Validate = $false 59 | Write-Error "`nERROR: Failed to Download $BaseXML" 60 | } 61 | #endregion 62 | 63 | #region: Download BasePS1 64 | try { 65 | $Url = $BaseURL + $BasePS1 66 | Invoke-WebRequest $Url -OutFile ($BaseDir + $BasePS1) -ErrorAction Stop 67 | } 68 | catch { 69 | # Error out if loading fails 70 | $Validate = $false 71 | Write-Error "`nERROR: Failed to Download $BasePS1" 72 | } 73 | #endregion 74 | 75 | 76 | #region: Check and Load BaseXML 77 | $BaseXMLPath = $BaseDir + $BaseXML 78 | If (Test-Path $BaseXMLPath ) { 79 | try {$BaseXMLContent = [XML] (Get-Content $BaseXMLPath )} catch {$Validate = $false; Write-Error "`nERROR: Invalid $BaseXML"} 80 | } Else { 81 | # Error out if loading fails 82 | $Validate = $false 83 | Write-Error "`nERROR: Cannot load $BaseXML" 84 | } 85 | #endregion 86 | 87 | #region: Download Files from BaseXML 88 | [Array] $BaseFiles = $BaseXMLContent.Updater.Files.File 89 | Foreach($BaseFile in $BaseFiles){ 90 | try { 91 | $Url = $BaseURL + $BaseFile 92 | Invoke-WebRequest $Url -OutFile ($BaseDir + $BaseFile) -ErrorAction Stop 93 | } 94 | catch { 95 | # Error out if loading fails 96 | $Validate = $false 97 | Write-Error "`nERROR: Failed to Download $BaseFile" 98 | } 99 | } 100 | #endregion 101 | 102 | #region: Download Customer Files 103 | if ($Config -ne "Default") { 104 | [Array] $ConfigFiles = @("Customer-" + $Config + ".xml"; "Customer-" + $Config + ".ps1") 105 | Foreach($ConfigFile in $ConfigFiles){ 106 | try { 107 | $Url = $BaseURL + $ConfigFile 108 | Invoke-WebRequest $Url -OutFile ($BaseDir + $ConfigFile) 109 | } 110 | catch { 111 | # Error out if loading fails 112 | $Validate = $false 113 | Write-Error "`nERROR: Failed to Download $ConfigFile" 114 | } 115 | } 116 | } 117 | #endregion 118 | 119 | #region: Updater Check 120 | $myFile = $MyInvocation.MyCommand.Path 121 | $myFileHash = (Get-FileHash -Path $myFile -Algorithm MD5).Hash 122 | $newFile = ($BaseDir + $BasePS1) 123 | $newFileHash = (Get-FileHash -Path $newFile -Algorithm MD5).Hash 124 | 125 | Write-Output "`nMy Updater File: $myFile `nMD5 Hash: $myFileHash" 126 | Write-Output "`nNew Updater File: $newFile `nMD5 Hash: $newFileHash" 127 | 128 | if ($myFileHash -ne $newFileHash -and $IgnoreUpdate -eq $False) { 129 | try { 130 | Copy-Item $newFile -Destination $($myFile) 131 | Write-Warning "Replacing local Updater.ps1 with Server Version. Exiting this Version and wait for next run..." 132 | Stop-Transcript 133 | Exit 134 | } 135 | catch { 136 | # Error out if replacing fails 137 | $Validate = $false 138 | Write-Error "`nERROR: Failed to Update Update.ps1" 139 | } 140 | } 141 | elseif ($myFileHash -ne $newFileHash -and $IgnoreUpdate -eq $true) { 142 | Write-Warning "Replacing local Updater.ps1 with Server Version skipped..." 143 | } 144 | elseif ($myFileHash -eq $newFileHash ) { 145 | Write-output "No Updater.ps1 update needed..." 146 | } 147 | #endregion 148 | 149 | #region: Start Base Script 150 | if($Validate -eq $True) { 151 | $BaseScript = ($BaseXMLContent.Updater.Variable | Where-Object {$_.Name -eq "BaseScript"}).Value 152 | Write-Output "`nStarting $BaseDir$BaseScript" 153 | Invoke-Expression ($BaseDir + $BaseScript) 154 | } 155 | else { 156 | Write-Warning "Starting $BaseDir$BaseScript skipped... Validation Error." 157 | } 158 | #endregion 159 | 160 | #region: Finalize 161 | Stop-Transcript 162 | 163 | if($Validate -eq $false) { 164 | Write-Error "`nERROR: Validation Error(s) occured during Script!" 165 | } 166 | #endregion -------------------------------------------------------------------------------- /PS-Framework/Updater.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | BaseScript.ps1 6 | BaseScript.xml 7 | myExample.ps1 8 | myExample.xml 9 | 10 | -------------------------------------------------------------------------------- /PS-Framework/myExample.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .NOTES 3 | =========================================================================== 4 | Created by: Markus Kraus 5 | Organization: mycloudrevolution.com 6 | Personal Blog: mycloudrevolution.com 7 | Twitter: @vMarkus_K 8 | =========================================================================== 9 | .DESCRIPTION 10 | This is a self updating PowerShell Script Framework. 11 | 12 | Module-Name: myExample 13 | Module Version: 1.1 14 | #> 15 | 16 | #region 1: Global Definitions 17 | $Validate = $True 18 | $myExampleScriptXML = "myExample.xml" 19 | #endregion 20 | 21 | #region 2: Check and Load myExampleXML 22 | $myExampleScriptXMLPath = $BaseDir + $myExampleScriptXML 23 | If (Test-Path $myExampleScriptXMLPath ) { 24 | try {$myExampleScriptXMLContent = [XML] (Get-Content $myExampleScriptXMLPath )} catch {$Validate = $false; Write-Error "`nERROR: Invalid $myExampleScriptXML"} 25 | } Else { 26 | # Error out if loading fails 27 | $Validate = $false 28 | Write-Error "`nERROR: Cannot load $myExampleScriptXML" 29 | } 30 | #endregion 31 | 32 | #region 3: Do myExample 33 | if($Validate -eq $True) { 34 | $Text = ($myExampleScriptXMLContent.myExample.Variable | Where-Object {$_.Name -eq "Text"}).Value 35 | try { 36 | $wshell = New-Object -ComObject Wscript.Shell 37 | $wshell.Popup("$Text",0,"Done",0x1) 38 | } 39 | catch { 40 | # Error out if loading fails 41 | $Validate = $false 42 | Write-Error "`nERROR: Failed to Create Popup." 43 | } 44 | 45 | } 46 | #endregion -------------------------------------------------------------------------------- /PS-Framework/myExample.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Title 3 | 4 | Self updating PowerShell Script Framework 5 | 6 | |Navigation| 7 | |-----------------| 8 | |[About](#About)| 9 | |[Features](#Features)| 10 | 11 | 12 | 13 | 14 | # About 15 | [*Back to top*](#Title) 16 | 17 | Project Owner: 18 | Markus Kraus (@vMarkus_K) 19 | 20 | Project WebSite: 21 | http://mycloudrevolution.com/projekte/powershell-script-framework/ 22 | 23 | Project Details: 24 | This is a self updating PowerShell Script Framework. 25 | The Updater.ps1 downloads all requirements from a WebServer and executes a list of Scripts. 26 | 27 | 28 | # Features 29 | [*Back to top*](#Title) 30 | 31 | --------------------------------------------------------------------------------