commit 0f88d07876d088f35346d204b36645c2cfaeff41 Author: freedbygrace Date: Thu Apr 30 11:10:23 2026 -0400 Initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..35063fc --- /dev/null +++ b/.gitignore @@ -0,0 +1,54 @@ +## A streamlined .gitignore for modern .NET projects +## including temporary files, build results, and +## files generated by popular .NET tools. If you are +## developing with Visual Studio, the VS .gitignore +## https://github.com/github/gitignore/blob/main/VisualStudio.gitignore +## has more thorough IDE-specific entries. +## +## Get latest from https://github.com/github/gitignore/blob/main/Dotnet.gitignore + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg + +# Others +~$* +*~ +CodeCoverage/ + +# MSBuild Binary and Structured Log +*.binlog + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml \ No newline at end of file diff --git a/Content/Place_Additional_Content_Here.txt b/Content/Place_Additional_Content_Here.txt new file mode 100644 index 0000000..fa7cc9c --- /dev/null +++ b/Content/Place_Additional_Content_Here.txt @@ -0,0 +1 @@ +### \ No newline at end of file diff --git a/Docs/Place_Guides_Here.txt b/Docs/Place_Guides_Here.txt new file mode 100644 index 0000000..fa7cc9c --- /dev/null +++ b/Docs/Place_Guides_Here.txt @@ -0,0 +1 @@ +### \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e62ec04 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/OSD-ScriptTemplate.exe b/OSD-ScriptTemplate.exe new file mode 100644 index 0000000..542687b Binary files /dev/null and b/OSD-ScriptTemplate.exe differ diff --git a/OSD-ScriptTemplate.ps1 b/OSD-ScriptTemplate.ps1 new file mode 100644 index 0000000..fc86eb2 --- /dev/null +++ b/OSD-ScriptTemplate.ps1 @@ -0,0 +1,188 @@ +#Requires -Version 5 + +<# + .SYNOPSIS + A short synopsis of of what the script does + + .DESCRIPTION + A meaningful description of what the script does + + .PARAMETER TaskSequenceVariables + One or more task sequence variable(s) to retrieve during task sequence execution. + If this parameter is not specified, all task sequence variable(s) will be stored into the variable 'TSVariableTable'. + Any task sequence variables that are new or have been updated will be saved back to the task sequence engine for futher usage. + + $TSVariable.MyCustomVariableName = "MyCustomVariableValue" + $TSVariable.Make = "MyDeviceModel" + + .PARAMETER LogDir + A valid folder path. If the folder does not exist, it will be created. This parameter can also be specified by the alias "LogPath". + + .PARAMETER ContinueOnError + Ignore failures. + + .EXAMPLE + Use this command to execute a VBSCript that will launch this powershell script automatically with the specified parameters. This is useful to avoid powershell execution complexities. + + cscript.exe /nologo "%FolderPathContainingScript%\%ScriptName%.vbs" /SwitchParameter /ScriptParameter:"%ScriptParameterValue%" /ScriptParameterArray:"%ScriptParameterValue1%,%ScriptParameterValue2%" + + wscript.exe /nologo "%FolderPathContainingScript%\%ScriptName%.vbs" /SwitchParameter /ScriptParameter:"%ScriptParameterValue%" /ScriptParameterArray:"%ScriptParameterValue1%,%ScriptParameterValue2%" + + .EXAMPLE + powershell.exe -ExecutionPolicy Bypass -NoProfile -NoLogo -File "%FolderPathContainingScript%\%ScriptName%.ps1" -SwitchParameter -ScriptParameter "%ScriptParameterValue%" + + .EXAMPLE + powershell.exe -ExecutionPolicy Bypass -NonInteractive -NoProfile -NoLogo -WindowStyle Hidden -Command "& '%FolderPathContainingScript%\%ScriptName%.ps1' -ScriptParameter1 '%ScriptParameter1Value%' -ScriptParameter2 %ScriptParameter2Value% -SwitchParameter" + + .NOTES + Any useful tidbits + + .LINK + A useful link +#> + +[CmdletBinding(SupportsShouldProcess=$True)] + Param + ( + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [Alias('TSVars', 'TSVs')] + [String[]]$TaskSequenceVariables, + + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [Alias('TSVD', 'TSVDL')] + [String[]]$TSVariableDecodeList, + + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [Alias('LogDir', 'LogPath')] + [System.IO.DirectoryInfo]$LogDirectory, + + [Parameter(Mandatory=$False)] + [Switch]$ContinueOnError + ) + +Function Test-ProcessElevationStatus + { + $Identity = [System.Security.Principal.WindowsIdentity]::GetCurrent() + $Principal = New-Object -TypeName 'System.Security.Principal.WindowsPrincipal' -ArgumentList ($Identity) + $Result = $Principal.IsInRole([System.Security.Principal.WindowsBuiltInRole]::Administrator) + + Write-Output -InputObject ($Result) + } + +Switch (Test-ProcessElevationStatus) + { + Default + { + Try + { + #region Define Default Action Preferences + $Script:InformationPreference = 'Continue' + $Script:DebugPreference = 'SilentlyContinue' + $Script:ErrorActionPreference = 'Stop' + $Script:VerbosePreference = 'SilentlyContinue' + $Script:WarningPreference = 'Continue' + $Script:ConfirmPreference = 'None' + $Script:WhatIfPreference = $False + #endregion + + #region Set the default exit code for the script (By default, the script will exit with an exit code of 0) + [System.Environment]::ExitCode = 0 + #endregion + + #region Initialize Toolkit (This operation loads functions, modules, and variables into the current session, so if you do not see a variable defined below, it is because it is defined in the Toolkit) + Try + { + [System.IO.FileInfo]$ToolkitScriptPath = "$([System.IO.Path]::GetDirectoryName($MyInvocation.MyCommand.Definition))\Toolkit\Toolkit.ps1" + + . "$($ToolkitScriptPath.FullName)" -CallingScriptInvocationInfo ($MyInvocation) -CallingScriptParameterSetName ($PSCmdlet.ParameterSetName) + } + Catch + { + [System.Environment]::ExitCode = 6000 + + Throw + } + #endregion + + #region Set default parameter values + Switch ($True) + { + {([System.String]::IsNullOrEmpty($ExampleVariable) -eq $True) -or ([System.String]::IsNullOrWhiteSpace($ExampleVariable) -eq $True)} + { + + } + } + #endregion + + #region Perform Script Actions + #Place custom code here + #endregion + } + Catch + { + #region Perform error handling actions + $ErrorHandlingDefinition.Invoke($Error[0], 2, $ContinueOnError.IsPresent) + #endregion + } + Finally + { + #region Perform finalization actions + $FinalizationActions.Invoke() + #endregion + } + } + + {($_ -eq $False)} + { + [System.IO.FileInfo]$ScriptPath = "$($MyInvocation.MyCommand.Definition)" + + #$CurrentExecutionPolicy = Get-ExecutionPolicy -Scope Process + + $CurrentExecutionPolicy = 'Bypass' + + $ArgumentList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $ArgumentList.Add("-ExecutionPolicy $($CurrentExecutionPolicy)") + $ArgumentList.Add('-NonInteractive') + $ArgumentList.Add('-NoProfile') + $ArgumentList.Add('-NoLogo') + $ArgumentList.Add('-NoExit') + $ArgumentList.Add('-Command') + $ArgumentList.Add("`"`& {. `"$($ScriptPath.FullName)`"") + + $MyInvocation.UnboundArguments.GetEnumerator() | ForEach-Object {$ArgumentList.Add("-$($_.Key) @($($_.Value | ForEach-Object {`"$($_)`"}))")} + + $PSBoundParameters.GetEnumerator() | ForEach-Object {$ArgumentList.Add("-$($_.Key) @($($_.Value | ForEach-Object {`"$($_)`"}))")} + + $ArgumentListTargetIndex = $ArgumentList.Count - 1 + + $ArgumentListIndexItem = $ArgumentList[$ArgumentListTargetIndex] + + $Null = $ArgumentList.RemoveAt($ArgumentListTargetIndex) + + $Null = $ArgumentList.Insert($ArgumentListTargetIndex, ($ArgumentListIndexItem + ';')) + + $ArgumentList.Add("[System.Environment]::Exit((`$LASTEXITCODE -Bor [Int](-Not `$? -And -Not `$LASTEXITCODE)))}`"") + + $ScriptInterpreterList = New-Object -TypeName 'System.Collections.Generic.List[System.String]' + $ScriptInterpreterList.Add('powershell.exe') + $ScriptInterpreterList.Add('pwsh.exe') + + :ScriptInterpreterListLoop ForEach ($ScriptInterpreter In $ScriptInterpreterList) + { + $ScriptInterpreterObject = Try {Get-Command -Name ($ScriptInterpreter) -ErrorAction SilentlyContinue} Catch {$Null} + + Switch ($Null -ine $ScriptInterpreterObject) + { + {($_ -eq $True)} + { + $Null = Start-Process -FilePath ($ScriptInterpreterObject.Path) -WorkingDirectory "$($Env:Temp.TrimEnd('\'))" -ArgumentList ($ArgumentList.ToArray()) -WindowStyle Normal -Verb RunAs -PassThru + + Break ScriptInterpreterListLoop + } + } + } + } + } \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7551cf --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Powershell-Script-Template + diff --git a/Toolkit/Functions/Start-ProcessWithOutput.ps1 b/Toolkit/Functions/Start-ProcessWithOutput.ps1 new file mode 100644 index 0000000..9d277f8 --- /dev/null +++ b/Toolkit/Functions/Start-ProcessWithOutput.ps1 @@ -0,0 +1,803 @@ +#region Start-ProcessWithOutput +Function Start-ProcessWithOutput + { + <# + .SYNOPSIS + Allows for the execution of processes with the ability to return their output without first dumping the content to a file. It can all be kept in memory. + + .DESCRIPTION + This is not the best option when your process returns a large enough amount of output to cause a memory leak or overflow. + + .PARAMETER FilePath + Your parameter description + + .PARAMETER WorkingDirectory + Your parameter description + + .PARAMETER ArgumentList + Your parameter description + + .PARAMETER AcceptableExitCodeList + A * can be used to accept all exit codes. + + .PARAMETER WindowStyle + Your parameter description + + .PARAMETER CreateNoWindow + Your parameter description + + .PARAMETER ExecutionTimeout + Your parameter description + + .PARAMETER ExecutionTimeoutInterval + Your parameter description + + .PARAMETER StandardInputObject + Your parameter description + + .PARAMETER ParsingExpression + A valid regular expression that will allow for the output to be parsed into objects. + + .PARAMETER SecureArgumentList + Your parameter description + + .PARAMETER LogOutput + Your parameter description + + .EXAMPLE + Start-ProcessWithOutput -FilePath 'cmd.exe' -ArgumentList '/c ipconfig /all' -AcceptableExitCodeList @('*') -CreateNoWindow -NoWait -Verbose + + .EXAMPLE + Start-ProcessWithOutput -FilePath 'cmd.exe' -ArgumentList '/c ipconfig /all' -AcceptableExitCodeList @('*') -CreateNoWindow -Timeout ([System.TimeSpan]::FromSeconds(30)) -Verbose + + .EXAMPLE + $StartProcessWithOutputParameters = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $StartProcessWithOutputParameters.FilePath = "dsregcmd.exe" + $StartProcessWithOutputParameters.WorkingDirectory = "$([System.Environment]::SystemDirectory)" + $StartProcessWithOutputParameters.ArgumentList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $StartProcessWithOutputParameters.ArgumentList.Add('/status') + $StartProcessWithOutputParameters.AcceptableExitCodeList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $StartProcessWithOutputParameters.AcceptableExitCodeList.Add('0') + $StartProcessWithOutputParameters.WindowStyle = "Hidden" + $StartProcessWithOutputParameters.Priority = "Normal" + $StartProcessWithOutputParameters.ParsingExpression = "(?:\s+)(?.+)(?:\s+\:\s+)(?.+)" + $StartProcessWithOutputParameters.LogOutput = $True + $StartProcessWithOutputParameters.ExecutionTimeout = [Timespan]::FromMinutes(1) + $StartProcessWithOutputParameters.ExecutionTimeoutInterval = [Timespan]::FromSeconds(30) + $StartProcessWithOutputParameters.StandardInputObjectList = New-Object -TypeName 'System.Collections.Generic.List[System.Object]' + $StartProcessWithOutputParameters.StandardInputObjectList.Add('S') + $StartProcessWithOutputParameters.SecureArgumentList = $False + $StartProcessWithOutputParameters.Verbose = $True + + $StartProcessWithOutputResult = Start-ProcessWithOutput @StartProcessWithOutputParameters + + Write-Output -InputObject ($StartProcessWithOutputResult) + + .EXAMPLE + $StartProcessWithOutputParameters = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $StartProcessWithOutputParameters.FilePath = "dsregcmd.exe" + $StartProcessWithOutputParameters.WorkingDirectory = "$([System.Environment]::SystemDirectory)" + $StartProcessWithOutputParameters.ArgumentList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $StartProcessWithOutputParameters.ArgumentList.Add('/status') + $StartProcessWithOutputParameters.AcceptableExitCodeList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $StartProcessWithOutputParameters.AcceptableExitCodeList.Add('0') + $StartProcessWithOutputParameters.WindowStyle = "Hidden" + $StartProcessWithOutputParameters.Priority = "Normal" + $StartProcessWithOutputParameters.ParsingExpression = "(?:\s+)(?.+)(?:\s+\:\s+)(?.+)" + $StartProcessWithOutputParameters.LogOutput = $True + $StartProcessWithOutputParameters.ExecutionTimeout = [Timespan]::FromMinutes(1) + $StartProcessWithOutputParameters.ExecutionTimeoutInterval = [Timespan]::FromSeconds(30) + $StartProcessWithOutputParameters.StandardInputObjectList = New-Object -TypeName 'System.Collections.Generic.List[System.Object]' + $StartProcessWithOutputParameters.StandardInputObjectList.Add('S') + $StartProcessWithOutputParameters.SecureArgumentList = $True + $StartProcessWithOutputParameters.Verbose = $True + + $StartProcessWithOutputResult = Start-ProcessWithOutput @StartProcessWithOutputParameters + + Write-Output -InputObject ($StartProcessWithOutputResult) + + .NOTES + Mileage may vary when parsing output and may have to be done using additional code outside of this function to address specific needs. + + .LINK + Place any useful link here where your function or cmdlet can be referenced + #> + + [CmdletBinding(DefaultParameterSetName = 'WindowStyle')] + Param + ( + [Parameter(Mandatory=$True)] + [ValidateNotNullOrEmpty()] + [Alias('FP')] + [String]$FilePath, + + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [Alias('WD')] + [System.IO.DirectoryInfo]$WorkingDirectory, + + [Parameter(Mandatory=$False)] + [AllowEmptyCollection()] + [AllowNull()] + [Alias('AL')] + [String[]]$ArgumentList, + + [Parameter(Mandatory=$False)] + [AllowEmptyCollection()] + [AllowNull()] + [Alias('AECL')] + [String[]]$AcceptableExitCodeList, + + [Parameter(Mandatory=$False, ParameterSetName = 'WindowStyle')] + [ValidateNotNullOrEmpty()] + [ValidateSet('Normal', 'Hidden', 'Minimized', 'Maximized')] + [Alias('WS')] + [String]$WindowStyle, + + [Parameter(Mandatory=$False, ParameterSetName = 'CreateNoWindow')] + [Alias('CNW')] + [Switch]$CreateNoWindow, + + [Parameter(Mandatory=$False)] + [Alias('NW')] + [Switch]$NoWait, + + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [ValidateSet('AboveNormal', 'BelowNormal', 'High', 'Idle', 'Normal', 'RealTime')] + [Alias('P')] + [String]$Priority, + + [Parameter(Mandatory=$False)] + [Alias('ET')] + [System.Timespan]$ExecutionTimeout, + + [Parameter(Mandatory=$False)] + [Alias('ETI')] + [System.Timespan]$ExecutionTimeoutInterval, + + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [Alias('SIO')] + [System.Object[]]$StandardInputObjectList, + + [Parameter(Mandatory=$False)] + [AllowEmptyString()] + [AllowNull()] + [Alias('StandardOutputParsingExpression', 'SOPE', 'PE')] + [Regex]$ParsingExpression, + + [Parameter(Mandatory=$False)] + [Alias('SAL')] + [Switch]$SecureArgumentList, + + [Parameter(Mandatory=$False)] + [Alias('LO')] + [Switch]$LogOutput, + + [Parameter(Mandatory=$False)] + [Alias('COE')] + [Switch]$ContinueOnError + ) + + Try + { + $DateTimeLogFormat = 'dddd, MMMM dd, yyyy @ hh:mm:ss.FFF tt' ###Monday, January 01, 2019 @ 10:15:34.000 AM### + [ScriptBlock]$GetCurrentDateTimeLogFormat = {(Get-Date).ToString($DateTimeLogFormat)} + + + + + + $CommonParameterList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $CommonParameterList.AddRange([System.Management.Automation.PSCmdlet]::CommonParameters) + $CommonParameterList.AddRange([System.Management.Automation.PSCmdlet]::OptionalCommonParameters) + + #Determine the date and time we executed the function + $FunctionStartTime = (Get-Date) + + [String]$CmdletName = $MyInvocation.MyCommand.Name + + $WriteLogMessage.Invoke(0, @("Function `'$($CmdletName)`' is beginning. Please Wait...")) + + #Define Default Action Preferences + $ErrorActionPreference = 'Stop' + + [String[]]$SuppliedScriptParameters = $PSBoundParameters.GetEnumerator() | ForEach-Object {"-$($_.Key):$($_.Value.GetType().Name)"} + $WriteLogMessage.Invoke(0, @("Supplied Function Parameter(s) = $($SuppliedScriptParameters -Join ', ')")) + + $WriteLogMessage.Invoke(0, @("Execution of $($CmdletName) began on $($FunctionStartTime.ToString($DateTimeLogFormat))")) + + $WriteLogMessage.Invoke(0, @("Parameter Set Name: $($PSCmdlet.ParameterSetName)")) + + #Set default parameter values (If necessary) + Switch ($True) + { + {([String]::IsNullOrEmpty($WindowStyle) -eq $True) -or ([String]::IsNullOrWhiteSpace($WindowStyle) -eq $True)} + { + [String]$WindowStyle = 'Hidden' + } + + {([String]::IsNullOrEmpty($Priority) -eq $True) -or ([String]::IsNullOrWhiteSpace($Priority) -eq $True)} + { + [String]$Priority = 'Normal' + } + + {($Null -ine $ExecutionTimeout)} + { + Switch ($Null -ieq $ExecutionTimeoutInterval) + { + {($_ -eq $True)} + { + $ExecutionTimeoutInterval = [System.TimeSpan]::FromSeconds(15) + } + } + } + } + + [ScriptBlock]$GetTimeSpanMessage = { + Param + ( + [System.TimeSpan]$InputObject + ) + + $InputObjectMessageBuilder = New-Object -TypeName 'System.Text.StringBuilder' + + $InputObjectProperties = $InputObject | Select-Object -Property @('Days', 'Hours', 'Minutes', 'Seconds', 'Milliseconds') + + $InputObjectPropertyNameList = New-Object -TypeName 'System.Collections.Generic.List[System.String]' + + ($InputObjectProperties.PSObject.Properties | Where-Object {($_.Value -gt 0)}).Name | ForEach-Object {($InputObjectPropertyNameList.Add($_))} + + $InputObjectPropertyNameListUpperBound = $InputObjectPropertyNameList.ToArray().GetUpperBound(0) + + For ($InputObjectPropertyNameListIndex = 0; $InputObjectPropertyNameListIndex -lt $InputObjectPropertyNameList.Count; $InputObjectPropertyNameListIndex++) + { + $InputObjectPropertyName = $InputObjectPropertyNameList[$InputObjectPropertyNameListIndex] + + $InputObjectPropertyValue = $InputObject.$($InputObjectPropertyName) + + Switch ($True) + { + {($InputObjectPropertyNameList.Count -gt 1) -and ($InputObjectPropertyNameListIndex -eq $InputObjectPropertyNameListUpperBound)} + { + $Null = $InputObjectMessageBuilder.Append('and ') + } + + {($InputObjectPropertyValue -eq 1)} + { + $Null = $InputObjectMessageBuilder.Append("$($InputObjectPropertyValue) $($InputObjectPropertyName.TrimEnd('s').ToLower())") + } + + {($InputObjectPropertyValue -gt 1)} + { + $Null = $InputObjectMessageBuilder.Append("$($InputObjectPropertyValue) $($InputObjectPropertyName.ToLower())") + } + + {($InputObjectPropertyNameList.Count -gt 1) -and ($InputObjectPropertyNameListIndex -ne $InputObjectPropertyNameListUpperBound)} + { + $Null = $InputObjectMessageBuilder.Append(', ') + } + } + } + + $OutputObject = $InputObjectMessageBuilder.ToString() + + Switch ($InputObjectMessageBuilder.Length -gt 0) + { + {($_ -eq $True)} + { + $OutputObject = $InputObjectMessageBuilder.ToString() + } + + Default + { + $OutputObject = 'N/A' + } + } + + Write-Output -InputObject ($OutputObject) + } + + [ScriptBlock]$WriteStandardOutputStream = { + Param + ( + [System.Object[]]$StandardInputObjectList, + [Switch]$SecureArgumentList + ) + + Switch (($Null -ine $StandardInputObjectList) -and ($StandardInputObjectList.Count -gt 0)) + { + {($_ -eq $True)} + { + $StandardInputObjectListCounter = 1 + + For ($StandardInputObjectListIndex = 0; $StandardInputObjectListIndex -lt $StandardInputObjectList.Count; $StandardInputObjectListIndex++) + { + Try + { + $StandardInputObject = $StandardInputObjectList[$StandardInputObjectListIndex] + + Switch ($SecureArgumentList.IsPresent) + { + {($_ -eq $True)} + { + $ObfuscationCharacter = '*' + + $ObfuscationCharacterCount = Get-Random -Minimum 5 -Maximum 20 + + $ObfuscationValue = $ObfuscationCharacter.PadRight($ObfuscationCharacterCount, $ObfuscationCharacter) + + $WriteLogMessage.Invoke(0, @("Attempting to write standard input object $($StandardInputObjectListCounter) of $($StandardInputObjectList.Count) to the standard input stream for process ID $($Process.ID). Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Object Value: $($ObfuscationValue)")) + } + + Default + { + $WriteLogMessage.Invoke(0, @("Attempting to write standard input object $($StandardInputObjectListCounter) of $($StandardInputObjectList.Count) to the standard input stream for process ID $($Process.ID). Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Object Value: $($StandardInputObject)")) + } + } + + $Null = $Process.StandardInput.WriteLine($StandardInputObject) + } + Catch + { + $ExceptionPropertyDictionary = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $ExceptionPropertyDictionary.Add('Message', $_.Exception.Message) + $ExceptionPropertyDictionary.Add('Category', $_.Exception.ErrorRecord.FullyQualifiedErrorID) + $ExceptionPropertyDictionary.Add('LineNumber', $_.InvocationInfo.ScriptLineNumber) + $ExceptionPropertyDictionary.Add('LinePosition', $_.InvocationInfo.OffsetInLine) + $ExceptionPropertyDictionary.Add('Code', $_.InvocationInfo.Line.Trim()) + + $ExceptionMessageList = New-Object -TypeName 'System.Collections.Generic.List[String]' + + ForEach ($ExceptionProperty In $ExceptionPropertyDictionary.GetEnumerator()) + { + $ExceptionMessageList.Add("[$($ExceptionProperty.Key): $($ExceptionProperty.Value)]") + } + + $WriteLogMessage.Invoke(2, @("$($ExceptionMessageList -Join ' ')")) + } + Finally + { + $StandardInputObjectListCounter++ + } + } + } + } + } + + $OutputObjectProperties = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $OutputObjectProperties.ExitCode = -1 + $OutputObjectProperties.ExitCodeAsHex = $Null + $OutputObjectProperties.ExitCodeAsInteger = $Null + $OutputObjectProperties.ExitCodeAsDecimal = $Null + $OutputObjectProperties.ProcessObject = $Null + $OutputObjectProperties.StandardOutput = $Null + $OutputObjectProperties.StandardOutputObject = $Null + $OutputObjectProperties.StandardError = $Null + $OutputObjectProperties.StandardErrorObject = $Null + + $Process = New-Object -TypeName 'System.Diagnostics.Process' + $Process.StartInfo.FileName = $FilePath + $Process.StartInfo.UseShellExecute = $False + $Process.StartInfo.RedirectStandardOutput = $True + $Process.StartInfo.RedirectStandardError = $True + $Process.StartInfo.RedirectStandardInput = $True + + Switch ($True) + { + {([String]::IsNullOrEmpty($WorkingDirectory.FullName) -eq $False) -and ([String]::IsNullOrWhiteSpace($WorkingDirectory.FullName) -eq $False)} + { + Switch ($True) + { + {([System.IO.Directory]::Exists($WorkingDirectory.FullName) -eq $False)} + { + $WriteLogMessage.Invoke(0, @("Attempting to create the non-existing process working directory. Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Path: $($WorkingDirectory.FullName)")) + + $Null = [System.IO.Directory]::CreateDirectory($WorkingDirectory.FullName) + } + } + + $Process.StartInfo.WorkingDirectory = $WorkingDirectory.FullName + } + } + + Switch ($PSCmdlet.ParameterSetName) + { + {($_ -iin @('CreateNoWindow'))} + { + $Process.StartInfo.CreateNoWindow = $True + } + + {($_ -iin @('WindowStyle'))} + { + $Process.StartInfo.WindowStyle = [System.Diagnostics.ProcessWindowStyle]::"$($WindowStyle)" + } + } + + Switch (($Null -ieq $AcceptableExitCodeList) -or ($AcceptableExitCodeList.Count -eq 0)) + { + {($_ -eq $True)} + { + $DefaultExitCodeList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $DefaultExitCodeList.Add('0') + $DefaultExitCodeList.Add('3010') + + $AcceptableExitCodeList = $DefaultExitCodeList.ToArray() + } + } + + $CommandExecutionMessageBuilder = New-Object -TypeName 'System.Text.StringBuilder' + + $Null = $CommandExecutionMessageBuilder.Append('Attempting to execute the following command:') + $Null = $CommandExecutionMessageBuilder.Append(' ') + $Null = $CommandExecutionMessageBuilder.Append($Process.StartInfo.FileName) + + Switch (($Null -ine $ArgumentList) -and ($ArgumentList.Count -gt 0)) + { + {($_ -eq $True)} + { + $Process.StartInfo.Arguments = $ArgumentList -Join ' ' + + Switch ($SecureArgumentList.IsPresent) + { + {($_ -eq $True)} + { + $ObfuscationCharacter = '*' + + $ObfuscationCharacterCount = Get-Random -Minimum 5 -Maximum ($Process.StartInfo.Arguments.Length) + + $ObfuscationValue = $ObfuscationCharacter.PadRight($ObfuscationCharacterCount, $ObfuscationCharacter) + + $Null = $CommandExecutionMessageBuilder.Append(' ') + $Null = $CommandExecutionMessageBuilder.Append($ObfuscationValue) + } + + Default + { + $Null = $CommandExecutionMessageBuilder.Append(' ') + $Null = $CommandExecutionMessageBuilder.Append($Process.StartInfo.Arguments) + } + } + } + } + + $WriteLogMessage.Invoke(0, @("$($CommandExecutionMessageBuilder.ToString())")) + + $WriteLogMessage.Invoke(0, @("Acceptable Exit Code List: $($AcceptableExitCodeList -Join '; ')")) + + Switch ($NoWait.IsPresent) + { + {($_ -eq $True)} + { + $Null = $Process.Start() + + $WriteLogMessage.Invoke(0, @("Skipping the execution wait for process ID $($Process.ID).")) + + $WriteLogMessage.Invoke(0, @("[ProcessName: $([System.IO.Path]::GetFileName($Process.Path))] [ID: $($Process.ID)] [Version: $($Process.FileVersion)] [Description: $($Process.Description)] [Path: $($Process.Path)] ")) + + $Null = $WriteStandardOutputStream.InvokeReturnAsIs($StandardInputObjectList, $SecureArgumentList.IsPresent) + + $OutputObjectProperties.StandardOutput = $Null + $OutputObjectProperties.StandardError = $Null + } + + Default + { + Switch ($Null -ieq $ExecutionTimeout) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("A timeout was not specified for process ID $($Process.ID).")) + + $WriteLogMessage.Invoke(0, @("The wait for process ID $($Process.ID) termination will be indefinite.")) + } + + Default + { + $ProcessTimeoutStopWatch = New-Object -TypeName 'System.Diagnostics.StopWatch' + + $Null = $ProcessTimeoutStopWatch.Start() + } + } + + $Null = $Process.Start() + + Switch ($Process.PriorityClass -ine $Priority) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Attempting to change the process priority class for process ID $($Process.ID) from `"$($Process.PriorityClass)`" to `"$($Priority)`". Please Wait...")) + + $Null = $Process.PriorityClass = [System.Diagnostics.ProcessPriorityClass]::"$($Priority)" + } + } + + $WriteLogMessage.Invoke(0, @("[ProcessName: $([System.IO.Path]::GetFileName($Process.Path))] [ID: $($Process.ID)] [Version: $($Process.FileVersion)] [Description: $($Process.Description)] [Path: $($Process.Path)] ")) + + $WriteLogMessage.Invoke(0, @("Process Start Time: $($Process.StartTime.ToString($DateTimeLogFormat))")) + + Switch ($Null -ine $ExecutionTimeout) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Process Timeout Time: $($Process.StartTime.AddTicks($ExecutionTimeout.Ticks).ToString($DateTimeLogFormat))")) + + $WriteLogMessage.Invoke(0, @("Process Timeout Duration: $($GetTimeSpanMessage.InvokeReturnAsIs($ExecutionTimeout))")) + } + } + + $Null = $WriteStandardOutputStream.InvokeReturnAsIs($StandardInputObjectList, $SecureArgumentList.IsPresent) + + $OutputObjectProperties.StandardOutput = $Process.StandardOutput.ReadToEndAsync() + $OutputObjectProperties.StandardError = $Process.StandardError.ReadToEndAsync() + + $ProcessTimeOutLoopCondition = {$Process.HasExited -eq $False} + + :ProcessTimeoutLoop While ($ProcessTimeOutLoopCondition.InvokeReturnAsIs() -eq $True) + { + $WriteLogMessage.Invoke(0, @("Process ID $($Process.ID) has been running for $($GetTimeSpanMessage.InvokeReturnAsIs($ProcessTimeoutStopWatch.Elapsed)).")) + + Switch ($Null -ine $ExecutionTimeout) + { + {($_ -eq $True)} + { + Switch ($ProcessTimeoutStopWatch.Elapsed.TotalMilliseconds -le $ExecutionTimeout.TotalMilliseconds) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Process ID $($Process.ID) has not exceeded the maximum timeout duration of $($GetTimeSpanMessage.InvokeReturnAsIs($ExecutionTimeout)).")) + } + + Default + { + $WriteLogMessage.Invoke(0, @("Process ID $($Process.ID) has exceeded the maximum timeout duration of $($GetTimeSpanMessage.InvokeReturnAsIs($ExecutionTimeout)).")) + + Try + { + $WriteLogMessage.Invoke(0, @("Attempting to forcibly terminate the process ID $($Process.ID). Please Wait...")) + + $Null = $Process.Kill() + + Switch ($?) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Process ID $($Process.ID) was forcibly terminated successfully.")) + } + } + } + Catch + { + $WriteLogMessage.Invoke(2, @("$($_.Exception.Message)")) + } + + Break ProcessTimeoutLoop + } + } + } + } + + $WriteLogMessage.Invoke(0, @("Checking again in another $($GetTimeSpanMessage.InvokeReturnAsIs($ExecutionTimeoutInterval)). Please Wait...")) + + $Null = Start-Sleep -Milliseconds ($ExecutionTimeoutInterval.TotalMilliseconds) + } + + $OutputObjectProperties.ExitCode = Try {$Process.ExitCode} Catch {$Null} + $OutputObjectProperties.ExitCodeAsHex = Try {'0x' + [System.Convert]::ToString($OutputObjectProperties.ExitCode, 16).PadLeft(8, '0').ToUpper()} Catch {$Null} + $OutputObjectProperties.ExitCodeAsInteger = Try {$OutputObjectProperties.ExitCodeAsHex -As [Int]} Catch {$Null} + $OutputObjectProperties.ExitCodeAsDecimal = Try {[System.Convert]::ToString($OutputObjectProperties.ExitCodeAsHex, 10)} Catch {$Null} + + $ExitCodeMessageList = New-Object -TypeName 'System.Collections.Generic.List[String]' + + $Null = $OutputObjectProperties.GetEnumerator() | Where-Object {($_.Key -imatch '(^ExitCode.*$)')} | Sort-Object -Property @('Key') | ForEach-Object {$ExitCodeMessageList.Add("[$($_.Key): $($_.Value)]")} + + $ProcessExecutionTimespan = New-TimeSpan -Start ($Process.StartTime) -End ($Process.ExitTime) + + $OutputObjectProperties.ProcessObject = $Process | Select-Object -Property @('*') -ExcludeProperty @('ExitCode', 'StandardInput', 'StandardOutput', 'StandardError', 'SafeHandle', 'Threads', 'StartInfo') + + $WriteLogMessage.Invoke(0, @("Process Exit Time: $($Process.ExitTime.ToString($DateTimeLogFormat))")) + + #Dispose of the process object + Try {$Null = $Process.Dispose()} Catch {} + + $WriteLogMessage.Invoke(0, @("The command execution took $($GetTimeSpanMessage.InvokeReturnAsIs($ProcessExecutionTimespan)).")) + + Switch (($AcceptableExitCodeList -icontains '*') -or ($OutputObjectProperties.ExitCode.ToString() -iin $AcceptableExitCodeList) -or ($OutputObjectProperties.ExitCodeAsHex.ToString() -iin $AcceptableExitCodeList) -or ($OutputObjectProperties.ExitCodeAsInteger.ToString() -iin $AcceptableExitCodeList) -or ($OutputObjectProperties.ExitCodeAsDecimal.ToString() -iin $AcceptableExitCodeList)) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("The command execution was successful. $($ExitCodeMessageList -Join ' ')")) + + [Boolean]$CommandExecutionErrorOccured = $False + } + + {($_ -eq $False)} + { + $WriteLogMessage.Invoke(2, @("The command execution was unsuccessful. $($ExitCodeMessageList -Join ' ')")) + + $ErrorMessage = "The command execution was unsuccessful. $($ExitCodeMessageList -Join ' ')" + $Exception = [System.Exception]::New($ErrorMessage) + $ErrorRecord = [System.Management.Automation.ErrorRecord]::New($Exception, [System.Management.Automation.ErrorCategory]::InvalidResult.ToString(), [System.Management.Automation.ErrorCategory]::InvalidResult, $Process) + + [Boolean]$CommandExecutionErrorOccured = $True + } + } + + Switch (([String]::IsNullOrEmpty($ParsingExpression) -eq $False) -and ([String]::IsNullOrWhiteSpace($ParsingExpression) -eq $False)) + { + {($_ -eq $True)} + { + $RegexOptions = New-Object -TypeName 'System.Collections.Generic.List[System.Text.RegularExpressions.RegexOptions]' + $RegexOptions.Add('IgnoreCase') + $RegexOptions.Add('Multiline') + + $Regex = New-Object -TypeName 'System.Text.RegularExpressions.Regex' -ArgumentList @($ParsingExpression, $RegexOptions.ToArray()) + + $OutputStreamDictionary = New-Object -TypeName 'System.Collections.Generic.Dictionary[[String], [String]]' + $OutputStreamDictionary.Add('StandardOutput', $OutputObjectProperties.StandardOutput) + $OutputStreamDictionary.Add('StandardError', $OutputObjectProperties.StandardError) + + ForEach ($OutputStream In $OutputStreamDictionary.GetEnumerator()) + { + Switch (([String]::IsNullOrEmpty($OutputStream.Value) -eq $False) -and ([String]::IsNullOrWhiteSpace($OutputStream.Value) -eq $False)) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Attempting to parse the `"$($OutputStream.Key)`" property value. Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Regular Expression: $($ParsingExpression)")) + + $WriteLogMessage.Invoke(0, @("Regular Expression Options: $($RegexOptions -Join ', ')")) + + $OutputStreamRegexResult = $Regex.IsMatch($OutputStream.Value) + + Switch ($OutputStreamRegexResult) + { + {($_ -eq $True)} + { + $RegexMatchList = $Regex.Matches($OutputStream.Value) + + $WriteLogMessage.Invoke(0, @("The `"$($OutputStream.Key)`" property value matches the regular expression. $($RegexMatchList.Count) matches were found.")) + + $OutputObjectProperties."$($OutputStream.Key)Object" = $RegexMatchList + } + + Default + { + $WriteLogMessage.Invoke(0, @("The `"$($OutputStream.Key)`" property value does not match the regular expression.")) + + $OutputObjectProperties."$($OutputStream.Key)Object" = New-Object -TypeName 'System.Collections.Generic.List[System.Text.RegularExpressions.Match]' + } + } + } + + Default + { + $WriteLogMessage.Invoke(0, @("Skipping the parsing of the `"$($OutputStream.Key)`" property value because it is blank.")) + } + } + } + } + } + + $Null = $ProcessTimeoutStopWatch.Stop() + + $Null = $ProcessTimeoutStopWatch.Reset() + } + } + } + Catch + { + $ExceptionPropertyDictionary = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $ExceptionPropertyDictionary.Add('Message', $_.Exception.Message) + $ExceptionPropertyDictionary.Add('Category', $_.Exception.ErrorRecord.FullyQualifiedErrorID) + $ExceptionPropertyDictionary.Add('LineNumber', $_.InvocationInfo.ScriptLineNumber) + $ExceptionPropertyDictionary.Add('LinePosition', $_.InvocationInfo.OffsetInLine) + $ExceptionPropertyDictionary.Add('Code', $_.InvocationInfo.Line.Trim()) + + $ExceptionMessageList = New-Object -TypeName 'System.Collections.Generic.List[String]' + + ForEach ($ExceptionProperty In $ExceptionPropertyDictionary.GetEnumerator()) + { + $ExceptionMessageList.Add("[$($ExceptionProperty.Key): $($ExceptionProperty.Value)]") + } + + $WriteLogMessage.Invoke(2, @("$($ExceptionMessageList -Join ' ')")) + } + Finally + { + $OutputObjectProperties.StandardOutput = Try {$OutputObjectProperties.StandardOutput.Result} Catch {$Null} + $OutputObjectProperties.StandardError = Try {$OutputObjectProperties.StandardError.Result} Catch {$Null} + + $OutputObject = New-Object -TypeName 'PSObject' -Property ($OutputObjectProperties) + + Switch (($LogOutput.IsPresent -eq $True) -or ($LogOutput -eq $True) -or ($CommandExecutionErrorOccured -eq $True)) + { + {($_ -eq $True)} + { + ForEach ($Property In $OutputObject.PSObject.Properties) + { + Switch ($Property.Name) + { + {($_ -iin @('StandardOutput', 'StandardError'))} + { + Switch (([String]::IsNullOrEmpty($Property.Value) -eq $False) -and ([String]::IsNullOrWhiteSpace($Property.Value) -eq $False)) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("$($Property.Name): $($Property.Value)")) + } + + Default + { + $WriteLogMessage.Invoke(0, @("$($Property.Name): N/A")) + } + } + } + } + } + } + } + + Try + { + Switch ($NoWait.IsPresent) + { + {($_ -eq $False)} + { + Switch ($Process.HasExited) + { + {($_ -eq $False)} + { + $WriteLogMessage.Invoke(0, @("Attempting to forcibly terminate the process ID $($Process.ID). Please Wait...")) + + $Null = Try {$Process.CancelErrorRead()} Catch {} + $Null = Try {$Process.CancelOutputRead()} Catch {} + $Null = Try {$Process.Kill()} Catch {} + $Null = Try {$Process.Dispose()} Catch {} + } + } + } + } + } + Catch + { + + } + + #Determine the date and time the function completed execution + $FunctionEndTime = (Get-Date) + + $WriteLogMessage.Invoke(0, @("Execution of $($CmdletName) ended on $($FunctionEndTime.ToString($DateTimeLogFormat))")) + + #Log the total script execution time + $FunctionExecutionTimespan = New-TimeSpan -Start ($FunctionStartTime) -End ($FunctionEndTime) + + $WriteLogMessage.Invoke(0, @("Function execution took $($GetTimeSpanMessage.InvokeReturnAsIs($FunctionExecutionTimespan)).")) + + $WriteLogMessage.Invoke(0, @("Function `'$($CmdletName)`' is completed.")) + + Switch ($CommandExecutionErrorOccured) + { + {($_ -eq $True)} + { + Write-Output -InputObject ($OutputObject) + + If ($ContinueOnError.IsPresent -eq $False) {$PSCmdlet.ThrowTerminatingError($ErrorRecord)} + } + + Default + { + Write-Output -InputObject ($OutputObject) + } + } + } + } +#endregion \ No newline at end of file diff --git a/Toolkit/Libraries/PlaceModulesHere.txt b/Toolkit/Libraries/PlaceModulesHere.txt new file mode 100644 index 0000000..e69de29 diff --git a/Toolkit/Modules/PlaceModulesHere.txt b/Toolkit/Modules/PlaceModulesHere.txt new file mode 100644 index 0000000..e69de29 diff --git a/Toolkit/Toolkit.ps1 b/Toolkit/Toolkit.ps1 new file mode 100644 index 0000000..2283c62 --- /dev/null +++ b/Toolkit/Toolkit.ps1 @@ -0,0 +1,1205 @@ +#Requires -Version 3 + +<# + .SYNOPSIS + PowerShell Toolkit providing reusable functions, modules, and infrastructure for parent scripts. + + .DESCRIPTION + This toolkit serves as a comprehensive foundation for PowerShell scripts, providing: + + - Automatic logging infrastructure with transcript support + - Error handling and reporting mechanisms + - Environment detection (Windows PE, Task Sequence, Full OS) + - WMI/CIM class loading for hardware and OS information + - Dynamic function and module loading from Toolkit directories + - Standardized date/time formatting + - Process execution helpers + - Network connectivity validation + - Special folder path resolution + - Log file rotation and cleanup + + The toolkit is designed to be dot-sourced by parent scripts, automatically initializing the + execution environment, loading dependencies, and providing consistent logging and error handling. + + Key Features: + - Automatic log directory detection based on environment (PE, TS, Full OS) + - Loads all functions from Toolkit\Functions directory + - Imports all modules from Toolkit\Modules directory + - Provides standardized scriptblocks for common operations + - Hardware information gathering and logging + - Exit code management with categorized ranges (Success, Warning, Error) + + .PARAMETER CallingScriptInvocationInfo + The invocation information from the calling script ($MyInvocation). This parameter is used to + determine the calling script's path, parameters, and execution context. + + Alias: CSIO + Type: System.Management.Automation.InvocationInfo + Required: False + + .PARAMETER CallingScriptParameterSetName + The parameter set name from the calling script ($PSCmdlet.ParameterSetName). Used for logging + which parameter set was invoked. + + Alias: CSPSN + Type: System.String + Required: False + + .EXAMPLE + # Basic toolkit initialization from a parent script + Try + { + [System.IO.FileInfo]$ToolkitScriptPath = "$([System.IO.Path]::GetDirectoryName($MyInvocation.MyCommand.Definition))\Toolkit\Toolkit.ps1" + . "$($ToolkitScriptPath.FullName)" -CallingScriptInvocationInfo ($MyInvocation) -CallingScriptParameterSetName ($PSCmdlet.ParameterSetName) + } + Catch + { + [System.Environment]::ExitCode = 6000 + Throw + } + + Description: + Standard toolkit initialization pattern used by parent scripts. Loads all toolkit functionality + and initializes logging. + + .EXAMPLE + # Using toolkit logging functions after initialization + $WriteLogMessage.Invoke(0, @("This is an informational message")) + $WriteLogMessage.Invoke(1, @("This is a verbose message")) + $WriteLogMessage.Invoke(2, @("This is a warning message")) + $WriteLogMessage.Invoke(3, @("This is an error message")) + + Description: + After toolkit initialization, use the $WriteLogMessage scriptblock to write log entries with + different severity levels. + + .EXAMPLE + # Using toolkit error handling + Try { + # Your code here + } + Catch { + $ErrorHandlingDefinition.Invoke($Error[0], 2, $ContinueOnError.IsPresent) + } + + Description: + Use the toolkit's standardized error handling scriptblock to process exceptions consistently. + + .EXAMPLE + # Accessing hardware information loaded by toolkit + Write-Host "Computer Name: $($ComputerSystem.Name)" + Write-Host "Serial Number: $($Bios.SerialNumber)" + Write-Host "Manufacturer: $($MSSystemInformation.SystemManufacturer)" + Write-Host "Model: $($MSSystemInformation.SystemProductName)" + + Description: + The toolkit automatically loads WMI/CIM classes for hardware information into variables. + + .EXAMPLE + # Using toolkit directory variables + Write-Host "Script Directory: $($CallingScriptDirectory.FullName)" + Write-Host "Toolkit Directory: $($ToolkitScriptDirectory.FullName)" + Write-Host "Content Directory: $($ContentDirectory.FullName)" + Write-Host "Tools Directory: $($ToolsDirectory_OSArchSpecific.FullName)" + + Description: + The toolkit provides pre-defined directory variables for common paths. + + .EXAMPLE + # Pausing script execution + $PauseScriptExecution.Invoke([System.TimeSpan]::FromSeconds(5)) + + Description: + Use the toolkit's pause scriptblock to delay execution with logging. + + .EXAMPLE + # Finalizing script execution + Try { + # Your script logic + } + Finally { + $FinalizationActions.Invoke() + } + + Description: + Always call the finalization scriptblock in the Finally block to properly close logs and + report execution time. + + .NOTES + Author: Toolkit Author + Version: 1.0 + Requirements: + - PowerShell 3.0 or higher + - Must be dot-sourced by parent scripts + - Expects specific directory structure (Functions, Modules, Tools, Content) + + The toolkit automatically: + - Creates log directories if they don't exist + - Rotates logs (keeps 3 most recent) + - Detects Windows PE environment + - Loads all .ps1 files from Functions directory + - Imports all modules from Modules directory + - Provides consistent date/time formatting + + .LINK + https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands +#> + +[CmdletBinding(SupportsShouldProcess=$True)] + Param + ( + [Parameter(Mandatory=$False)] + [ValidateNotNullOrEmpty()] + [Alias('CSIO')] + [System.Management.Automation.InvocationInfo]$CallingScriptInvocationInfo, + + [Parameter(Mandatory=$False)] + [AllowEmptyString()] + [AllowNull()] + [Alias('CSPSN')] + [System.String]$CallingScriptParameterSetName + ) + +Try + { + #region Define Exit Code Ranges + $ExitCodeRangeQueueDictionary = New-Object 'System.Collections.Generic.Dictionary[[System.String],[System.Collections.Generic.Queue[System.Int32]]]' + $ExitCodeRangeQueueDictionary["Success"] = New-Object 'System.Collections.Generic.Queue[System.Int32]' -ArgumentList (,[System.Int32[]](0..999)) + $ExitCodeRangeQueueDictionary["Warning"] = New-Object 'System.Collections.Generic.Queue[System.Int32]' -ArgumentList (,[System.Int32[]](1000..1999)) + $ExitCodeRangeQueueDictionary["Error"] = New-Object 'System.Collections.Generic.Queue[System.Int32]' -ArgumentList (,[System.Int32[]](2000..2999)) + #endregion + + #region Define the error handling definition + [ScriptBlock]$ErrorHandlingDefinition = { + Param + ( + [System.Management.Automation.ErrorRecord]$ErrorRecord, + [Int16]$Severity, + [Boolean]$ContinueOnError + ) + + [String]$LogMessageTimestampFormat = 'yyyy/MM/dd HH:mm:ss.FFF' + [ScriptBlock]$GetLogMessageTimestamp = {([DateTime]::UtcNow).ToString($LogMessageTimestampFormat)} + + $ExceptionPropertyDictionary = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $ExceptionPropertyDictionary.Message = $ErrorRecord.Exception.Message + $ExceptionPropertyDictionary.Category = $ErrorRecord.Exception.ErrorRecord.FullyQualifiedErrorID + $ExceptionPropertyDictionary.Script = Try {[System.IO.Path]::GetFileName($ErrorRecord.InvocationInfo.ScriptName)} Catch {$Null} + $ExceptionPropertyDictionary.LineNumber = $ErrorRecord.InvocationInfo.ScriptLineNumber + $ExceptionPropertyDictionary.LinePosition = $ErrorRecord.InvocationInfo.OffsetInLine + $ExceptionPropertyDictionary.Code = $ErrorRecord.InvocationInfo.Line.Trim() + + Switch ($Severity) + { + {($_ -in @(0, 1, 2, 3))} {$SeverityAlias = 'ERROR'} + } + + ForEach ($ExceptionProperty In $ExceptionPropertyDictionary.GetEnumerator()) + { + Switch ($Null -ine $ExceptionProperty.Value) + { + {($_ -eq $True)} + { + $ExceptionMessage = "[$($GetLogMessageTimestamp.Invoke())] - [$($SeverityAlias)] - $($ExceptionProperty.Key): $($ExceptionProperty.Value)" + + $LogMessageParameters = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $LogMessageParameters.Message = $ExceptionMessage + $LogMessageParameters.Verbose = $True + + Switch ($Severity) + { + {($_ -in @(0, 1, 2, 3))} {Write-Verbose @LogMessageParameters} + } + } + } + } + + Switch ($ContinueOnError) + { + {($_ -eq $False)} + { + Switch (($Null -ieq [System.Environment]::ExitCode) -or ([System.Environment]::ExitCode -eq 0)) + { + {($_ -eq $True)} + { + [System.Environment]::ExitCode = $ExitCodeRangeQueueDictionary["Error"].Dequeue() + } + } + + Throw + } + } + } + #endregion + + #region Define Date and Time Formats + $DateTimeLogFormat = 'dddd, MMMM dd, yyyy @ hh:mm:ss.FFF tt' ###Monday, January 01, 2019 @ 10:15:34.000 AM### + [ScriptBlock]$GetCurrentDateTimeLogFormat = {([System.DateTime]::UtcNow).ToString($DateTimeLogFormat)} + $DateTimeMessageFormat = 'yyyy/MM/dd HH:mm:ss.FFF' ###2022/03/22 11:12:48.347### + [ScriptBlock]$GetCurrentDateTimeMessageFormat = {([System.DateTime]::UtcNow).ToString($DateTimeMessageFormat)} + $DateFileFormat = 'yyyyMMdd' ###20190403### + [ScriptBlock]$GetCurrentDateFileFormat = {([System.DateTime]::UtcNow).ToString($DateFileFormat)} + $DateTimeFileFormat = 'yyyyMMdd_HHmmss' ###20190403_115354### + [ScriptBlock]$GetCurrentDateTimeFileFormat = {([System.DateTime]::UtcNow).ToString($DateTimeFileFormat)} + $DateTimeVersionFormat = 'yyyy.MM.dd.HHMM' ###2019.04.03.1153### + [ScriptBlock]$GetCurrentDateTimeVersionFormat = {([System.DateTime]::UtcNow).ToString($DateTimeVersionFormat)} + #endregion + + #region Define Toolkit Path Variables + $ToolkitScriptPath = [System.IO.FileInfo][System.IO.Path]::Combine($MyInvocation.MyCommand.Definition) + $ToolkitScriptDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolkitScriptPath.Directory.FullName) + $ToolkitScriptVersion = [System.Version]$ToolkitScriptPath.LastWriteTimeUtc.ToString($DateTimeVersionFormat) + $CallingScriptPath = [System.IO.FileInfo][System.IO.Path]::Combine($CallingScriptInvocationInfo.MyCommand.Definition) + $CallingScriptDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($CallingScriptPath.Directory.FullName) + $CallingScriptVersion = [System.Version]$CallingScriptPath.LastWriteTimeUtc.ToString($DateTimeVersionFormat) + $CallingScriptProcess = [System.Diagnostics.Process]::GetCurrentProcess() + $CallingScriptStartTime = $CallingScriptProcess.StartTime.ToUniversalTime() + $CallingScriptBoundParameters = $CallingScriptInvocationInfo.BoundParameters + $CallingScriptBoundParameterCount = $CallingScriptBoundParameters.Count + $CallingScriptUnboundArguments = $CallingScriptInvocationInfo.UnboundArguments + $CallingScriptUnboundArgumentCount = $CallingScriptUnboundArguments.Count + #endregion + + #region Define the logging scriptblock + [ScriptBlock]$WriteLogMessage = { + Param + ( + [Int16]$Severity, + [String[]]$LogMessageEntryList + ) + + $LogMessageEntryListCount = ($LogMessageEntryList | Measure-Object).Count + + Switch (($Null -ine $Severity) -and ($LogMessageEntryListCount -gt 0)) + { + {($_ -eq $True)} + { + [String]$LogMessageTimestampFormat = 'yyyy/MM/dd HH:mm:ss.FFF' + [ScriptBlock]$GetLogMessageTimestamp = {([System.DateTime]::UTCNow).ToString($LogMessageTimestampFormat)} + + Switch ($Severity) + { + {($_ -in @(0))} {$SeverityAlias = 'INFO'} + {($_ -in @(1))} {$SeverityAlias = 'VERBOSE'} + {($_ -in @(2))} {$SeverityAlias = 'WARNING'} + {($_ -in @(3))} {$SeverityAlias = 'ERROR'} + {($_ -in @(4))} {$SeverityAlias = 'DEBUG'} + } + + For ($LogMessageEntryIndex = 0; $LogMessageEntryIndex -lt $LogMessageEntryListCount; $LogMessageEntryIndex++) + { + $LogMessageEntry = $LogMessageEntryList[$LogMessageEntryIndex] + + $LogMessage = "[$($GetLogMessageTimestamp.Invoke())] - [$($SeverityAlias)] - $($LogMessageEntry)" + + $LogMessageParameters = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $LogMessageParameters.Message = $LogMessage + $LogMessageParameters.Verbose = $True + + Switch ($Severity) + { + {($_ -in @(0, 1))} {Write-Verbose @LogMessageParameters} + {($_ -in @(2, 3, 4))} {Write-Verbose @LogMessageParameters} + } + } + } + } + } + #endregion + + #region Load WMI Classes + $Baseboard = Get-CIMInstance -Namespace "root\CIMv2" -ClassName "Win32_Baseboard" -Property * + $Bios = Get-CIMInstance -Namespace "root\CIMv2" -ClassName "Win32_Bios" -Property * + $ComputerSystem = Get-CIMInstance -Namespace "root\CIMv2" -ClassName "Win32_ComputerSystem" -Property * + $MSSystemInformation = Get-CIMInstance -Namespace "root\WMI" -ClassName "MS_SystemInformation" -Property * + $OperatingSystem = Get-CIMInstance -Namespace "root\CIMv2" -ClassName "Win32_OperatingSystem" -Property * + #endregion + + #region Define Variables + $OSArchitecture = $($OperatingSystem.OSArchitecture).Replace("-bit", "").Replace("32", "86").Insert(0,"x").ToUpper() + $ContentDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolkitScriptDirectory.Parent.FullName, 'Content') + $FunctionsDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolkitScriptDirectory.FullName, 'Functions') + $ModulesDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolkitScriptDirectory.FullName, 'Modules') + $ToolsDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolkitScriptDirectory.FullName, 'Tools') + $ToolsDirectory_OSAll = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolsDirectory.FullName, 'All') + $ToolsDirectory_OSArchSpecific = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ToolsDirectory.FullName, $OSArchitecture) + $IsWindowsPE = Test-Path -Path 'HKLM:\SYSTEM\ControlSet001\Control\MiniNT' -ErrorAction SilentlyContinue + [ScriptBlock]$GetRandomGUID = {[System.GUID]::NewGUID().GUID.ToString().ToUpper()} + [String]$ParameterSetName = "$($PSCmdlet.ParameterSetName)" + $TextInfo = (Get-Culture).TextInfo + $RegexOptionList = New-Object -TypeName 'System.Collections.Generic.List[System.Text.RegularExpressions.RegexOptions]' + $RegexOptionList.Add('IgnoreCase') + $RegexOptionList.Add('Multiline') + $RegularExpressionTable = New-Object -TypeName 'System.Collections.Generic.Dictionary[[String], [System.Text.RegularExpressions.Regex]]' + $RegularExpressionTable.Base64 = New-Object -TypeName 'System.Text.RegularExpressions.Regex' -ArgumentList @('^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$', $RegexOptionList.ToArray()) + $CommonParameterList = New-Object -TypeName 'System.Collections.Generic.List[String]' + $CommonParameterList.AddRange([System.Management.Automation.PSCmdlet]::CommonParameters) + $CommonParameterList.AddRange([System.Management.Automation.PSCmdlet]::OptionalCommonParameters) + $TextEncoder = [System.Text.Encoding]::Default + $DirectorySeparator = [System.IO.Path]::DirectorySeparatorChar + #endregion + + #region Determine if a task sequence is running and any attributes + Try + { + [System.__ComObject]$TSEnvironment = New-Object -ComObject "Microsoft.SMS.TSEnvironment" + + Switch ($Null -ine $TSEnvironment) + { + {($_ -eq $True)} + { + $IsRunningTaskSequence = $True + + $WriteLogMessage.Invoke(0, @("A task sequence is running.")) + + [Boolean]$IsConfigurationManagerTaskSequence = [String]::IsNullOrEmpty($TSEnvironment.Value("_SMSTSPackageID")) -eq $False + + Switch ($IsConfigurationManagerTaskSequence) + { + {($_ -eq $True)} + { + $TaskSeqenceType = 'Microsoft Endpoint Configuration Manager (MECM)' + } + + {($_ -eq $False)} + { + $TaskSeqenceType = 'Microsoft Deployment Toolkit (MDT)' + } + } + } + + Default + { + $IsRunningTaskSequence = $False + } + } + } + Catch + { + $IsRunningTaskSequence = $False + } + + $WriteLogMessage.Invoke(0, @("Is Task Sequence Running: $($IsRunningTaskSequence)", "Task Seqence Type: $($TaskSeqenceType)")) + #endregion + + #region Determine default parameter value(s) + Switch ($True) + { + {([String]::IsNullOrEmpty($LogDirectory) -eq $True) -or ([String]::IsNullOrWhiteSpace($LogDirectory) -eq $True)} + { + Switch ($IsRunningTaskSequence) + { + {($_ -eq $True)} + { + Switch ($IsConfigurationManagerTaskSequence) + { + {($_ -eq $True)} + { + [String]$_SMSTSLogPath = "$($TSEnvironment.Value('_SMSTSLogPath'))" + } + + {($_ -eq $False)} + { + [String]$_SMSTSLogPath = "$($TSEnvironment.Value('LogPath'))" + } + } + + Switch ([String]::IsNullOrEmpty($_SMSTSLogPath)) + { + {($_ -eq $True)} + { + $TSLogDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($Env:Windir, 'Temp', 'SMSTSLog') + } + + {($_ -eq $False)} + { + Switch ($True) + { + {(Test-Path -Path ($_SMSTSLogPath) -PathType Container)} + { + [System.IO.DirectoryInfo]$TSLogDirectory = ($_SMSTSLogPath) + } + + {(Test-Path -Path ($_SMSTSLogPath) -PathType Leaf)} + { + [System.IO.DirectoryInfo]$TSLogDirectory = Split-Path -Path ($_SMSTSLogPath) -Parent + } + } + } + } + + $LogDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($TSLogDirectory.FullName, $CallingScriptPath.BaseName) + } + + Default + { + Switch ($IsWindowsPE) + { + {($_ -eq $True)} + { + $MDTBootImageDetectionPath = [System.IO.FileInfo][System.IO.Path]::Combine($Env:SystemDrive, 'Deploy', 'Scripts', 'Litetouch.wsf') + + [Boolean]$MDTBootImageDetected = Test-Path -Path ($MDTBootImageDetectionPath.FullName) + + Switch ($MDTBootImageDetected) + { + {($_ -eq $True)} + { + $LogDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($Env:SystemDrive, 'MININT', 'SMSOSD', 'OSDLOGS', $CallingScriptPath.BaseName) + } + + {($_ -eq $False)} + { + $LogDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($Env:Windir, 'Temp', 'SMSTSLog') + } + } + } + + Default + { + $LogDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($Env:Windir, 'Logs', 'Software', $CallingScriptPath.BaseName) + } + } + } + } + } + } + #endregion + + #region Define initialization actions + [ScriptBlock]$InitializationActions = { + $CallingScriptLogPath = [System.IO.FileInfo][System.IO.Path]::Combine($LogDirectory.FullName, "$($CallingScriptPath.BaseName)_$($GetCurrentDateFileFormat.Invoke()).log") + + If ($CallingScriptLogPath.Directory.Exists -eq $False) {$Null = $CallingScriptLogPath.Directory.Create()} + + $Null = Start-Transcript -Path ($CallingScriptLogPath.FullName) -Force -WhatIf:$False -ErrorAction SilentlyContinue + + $WriteLogMessage.Invoke(0, @("Execution of script `"$($CallingScriptPath.Name)`" began on $($CallingScriptStartTime.ToString($DateTimeLogFormat))")) + + $WriteLogMessage.Invoke(0, @("Script Path = $($CallingScriptPath.FullName)")) + + $WriteLogMessage.Invoke(0, @("Script Log Path = $($CallingScriptLogPath.FullName)")) + + $WriteLogMessage.Invoke(0, @("Script Version = $($CallingScriptVersion.ToString())")) + + [String[]]$AvailableCallingScriptParameters = (Get-Command -Name ($CallingScriptPath.FullName)).Parameters.GetEnumerator() | Where-Object {($_.Value.Name -inotin $CommonParameterList)} | ForEach-Object {"-$($_.Value.Name):$($_.Value.ParameterType.Name)"} + $WriteLogMessage.Invoke(0, @("Available Script Parameter(s): $($AvailableCallingScriptParameters -Join ', ')")) + + [String[]]$SuppliedCallingScriptParameters = $CallingScriptBoundParameters.GetEnumerator() | ForEach-Object {Try {"-$($_.Key):$($_.Value.GetType().Name)"} Catch {"-$($_.Key):Unknown"}} + $WriteLogMessage.Invoke(0, @("Supplied Script Parameter(s): $($SuppliedCallingScriptParameters -Join ', ')")) + + $WriteLogMessage.Invoke(0, @("$($CallingScriptBoundParameterCount) bound script parameter(s) were specified.")) + + $WriteLogMessage.Invoke(0, @("$($CallingScriptunboundArgumentCount) unbound script arguments were specified.")) + + $WriteLogMessage.Invoke(0, @("Process Command Line: $([System.Environment]::CommandLine)")) + + $WriteLogMessage.Invoke(0, @("Process Working Directory: $([System.Environment]::CurrentDirectory)")) + + $WriteLogMessage.Invoke(0, @("Process ID: $($PID)")) + + $WriteLogMessage.Invoke(0, @("Process is 64-Bit: $([System.Environment]::Is64BitProcess)")) + + Switch ($True) + { + {([String]::IsNullOrEmpty($CallingScriptParameterSetName) -eq $False) -and ([String]::IsNullOrWhiteSpace($CallingScriptParameterSetName) -eq $False)} + { + $WriteLogMessage.Invoke(0, @("Script Parameter Set Name: $($CallingScriptParameterSetName)")) + } + } + + $WriteLogMessage.Invoke(0, @("Attempting to load all required functions, modules, libraries, and variables from the toolkit. Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Toolkit Script Path: $($ToolkitScriptPath.FullName)")) + + $WriteLogMessage.Invoke(0, @("Toolkit Script Version: $($ToolkitScriptVersion.ToString())")) + } + #endregion + + #region Invoke initialization actions + $InitializationActions.Invoke() + #endregion + + #region Define finalization actions + [ScriptBlock]$FinalizationActions = { + #region If required, save any updated task sequence variables back to the task seqence + Switch ($IsRunningTaskSequence) + { + {($_ -eq $True)} + { + ForEach ($TSVariable In $TSVariableTable.GetEnumerator()) + { + [String]$TSVariableName = "$($TSVariable.Key)" + [String]$TSVariableCurrentValue = $TSEnvironment.Value($TSVariableName) + [String]$TSVariableNewValue = "$($TSVariable.Value -Join ',')" + + Switch ($TSVariableName -inotin $TSVariableDecodeList) + { + {($_ -eq $True)} + { + Switch ($TSVariableCurrentValue -ine $TSVariableNewValue) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Attempting to save the updated task sequence variable of `"$($TSVariableName)`". Please Wait...")) + + $Null = $TSEnvironment.Value($TSVariableName) = "$($TSVariableNewValue)" + } + } + } + } + } + + $Null = [System.Runtime.Interopservices.Marshal]::ReleaseComObject($TSEnvironment) + } + } + #endregion + + $CallingScriptEndTime = [System.DateTime]::UtcNow + + $WriteLogMessage.Invoke(0, @("Script execution of `"$($CallingScriptPath.Name)`" ended on $($CallingScriptEndTime.ToString($DateTimeLogFormat))")) + + $CallingScriptExecutionTimespan = New-TimeSpan -Start ($CallingScriptStartTime) -End ($CallingScriptEndTime) + + $WriteLogMessage.Invoke(0, @("Script execution took $($CallingScriptExecutionTimespan.Hours.ToString()) hour(s), $($CallingScriptExecutionTimespan.Minutes.ToString()) minute(s), $($CallingScriptExecutionTimespan.Seconds.ToString()) second(s), and $($CallingScriptExecutionTimespan.Milliseconds.ToString()) millisecond(s).")) + + $WriteLogMessage.Invoke(0, @("Exiting script `"$($CallingScriptPath.FullName)`" with exit code $([System.Environment]::ExitCode).")) + + Try {$Null = Stop-Transcript -ErrorAction SilentlyContinue} Catch {} + } + #endregion + + #region + Switch ($IsRunningTaskSequence) + { + {($_ -eq $True)} + { + $TaskSequenceVariableRetrievalList = New-Object -TypeName 'System.Collections.Generic.List[String]' + + Switch ($TaskSequenceVariables.Count -gt 0) + { + {($_ -eq $True)} + { + ForEach ($TaskSequenceVariable In $TaskSequenceVariables) + { + $TaskSequenceVariableRetrievalList.Add($TaskSequenceVariable) + } + } + } + + $WriteLogMessage.Invoke(0, @("Attempting to retrieve the task sequence variable list. Please Wait...")) + + Switch ($TaskSequenceVariableRetrievalList.Count -gt 0) + { + {($_ -eq $True)} + { + $TSVariableList = $TSEnvironment.GetVariables() | Where-Object {($_ -iin $TaskSequenceVariableRetrievalList)} | Sort-Object + } + + Default + { + $TSVariableList = $TSEnvironment.GetVariables() | Sort-Object + } + } + + $TSVariableListCount = ($TSVariableList | Measure-Object).Count + + $WriteLogMessage.Invoke(0, @("$($TSVariableListCount) task sequence variables were found.")) + + $TSVariableTable = [Ordered]@{} + + ForEach ($TSVariable In $TSVariableList) + { + $TSVariableName = $TSVariable + $TSVariableValue = $TSEnvironment.Value($TSVariableName) + + Switch ($True) + { + {($TSVariableName -inotmatch '(^_SMSTSTaskSequence$)|(^TaskSequence$)|(^.*Pass.*word.*$)')} + { + $WriteLogMessage.Invoke(4, @("Attempting to retrieve the value of task sequence variable `"$($TSVariableName)`". Please Wait... [Reference: `$TSVariableTable.`'$($TSVariableName)`']")) + } + + {($TSVariableName -iin $TSVariableDecodeList)} + { + Try + { + $WriteLogMessage.Invoke(0, @("Attempting to Base64 decode the `"$($TSVariableName)`" task sequence variable. Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Original Value: $($TSVariableValue)")) + + $TSVariableValueBytes = [System.Convert]::FromBase64String($TSVariableValue) + $TSVariableValue = [System.Text.Encoding]::ASCII.GetString($TSVariableValueBytes) + + $WriteLogMessage.Invoke(0, @("Toolkit Script Version: The Base64 decode attempt of the `"$($TSVariableName)`" task sequence variable was successful.")) + } + Catch + { + $WriteLogMessage.Invoke(0, @("The Base64 decode attempt of the `"$($TSVariableName)`" task sequence variable was unsuccessful. Setting the original value. Please Wait...")) + + $TSVariableValue = $TSEnvironment.Value($TSVariableName) + } + } + + {($TSVariableTable.Contains($TSVariableName) -eq $False)} + { + $TSVariableTable.Add($TSVariableName, $TSVariableValue) + } + } + } + } + } + #endregion + + #region Log Powershell Environment Information + $WriteLogMessage.Invoke(0, @("Powershell Version: $($PSVersionTable.PSVersion.ToString())")) + + #$ExecutionPolicyList = Try {$Null = Get-ExecutionPolicy -List -ErrorAction SilentlyContinue -WarningAction SilentlyContinue} Catch {$Null} + + #$ExecutionPolicyListCount = ($ExecutionPolicyList | Measure-Object).Count + + For ($ExecutionPolicyListIndex = 0; $ExecutionPolicyListIndex -lt $ExecutionPolicyListCount; $ExecutionPolicyListIndex++) + { + $ExecutionPolicy = $ExecutionPolicyList[$ExecutionPolicyListIndex] + + $WriteLogMessage.Invoke(0, @("The powershell execution policy is currently set to `"$($ExecutionPolicy.ExecutionPolicy.ToString())`" for the `"$($ExecutionPolicy.Scope.ToString())`" scope.")) + } + + Switch ($PSVersionTable.PSVersion) + { + {($_ -ge [Version]'6.0.0.0')} + { + $WriteLogMessage.Invoke(0, @("Powershell Platform: $($PSVersionTable.Platform)", "Powershell Edition: $($PSVersionTable.PSEdition)")) + $WriteLogMessage.Invoke(0, @("IsWindows: $($IsWindows)", "IsLinux: $($IsLinux)", "IsMacOS: $($IsMacOS)")) + } + } + #endregion + + #region Log Operating System Information + $OperatingSystemDetailsTable = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $OperatingSystemDetailsTable.ProductName = $OperatingSystem.Caption -ireplace '(Microsoft\s+)', '' + $OperatingSystemDetailsTable.Version = $OperatingSystem.Version + $OperatingSystemDetailsTable.Architecture = $OperatingSystem.OSArchitecture + + $OperatingSystemRegistryDetails = New-Object -TypeName 'System.Collections.Generic.List[PSObject]' + $OperatingSystemRegistryDetails.Add((New-Object -TypeName 'PSObject' -Property @{Alias = ''; Path = 'HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion'; ValueName = 'UBR'; Value = $Null})) + $OperatingSystemRegistryDetails.Add((New-Object -TypeName 'PSObject' -Property @{Alias = 'ReleaseVersion'; Path = 'HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion'; ValueName = 'ReleaseID'; Value = $Null})) + $OperatingSystemRegistryDetails.Add((New-Object -TypeName 'PSObject' -Property @{Alias = 'ReleaseID'; Path = 'HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion'; ValueName = 'DisplayVersion'; Value = $Null})) + + ForEach ($OperatingSystemRegistryDetail In $OperatingSystemRegistryDetails) + { + $OperatingSystemRegistryDetail.Value = Try {(Get-Item -Path $OperatingSystemRegistryDetail.Path).GetValue($OperatingSystemRegistryDetail.ValueName)} Catch {} + + :NextOSDetail Switch (([String]::IsNullOrEmpty($OperatingSystemRegistryDetail.Value) -eq $False) -and ([String]::IsNullOrWhiteSpace($OperatingSystemRegistryDetail.Value) -eq $False)) + { + {($_ -eq $True)} + { + Switch ($OperatingSystemRegistryDetail.ValueName) + { + {($_ -ieq 'UBR')} + { + $OperatingSystemDetailsTable.Version = $OperatingSystemDetailsTable.Version + '.' + $OperatingSystemRegistryDetail.Value + + Break NextOSDetail + } + } + + Switch (([String]::IsNullOrEmpty($OperatingSystemRegistryDetail.Alias) -eq $False) -and ([String]::IsNullOrWhiteSpace($OperatingSystemRegistryDetail.Alias) -eq $False)) + { + {($_ -eq $True)} + { + $OperatingSystemDetailsTable.$($OperatingSystemRegistryDetail.Alias) = $OperatingSystemRegistryDetail.Value + } + + Default + { + $OperatingSystemDetailsTable.$($OperatingSystemRegistryDetail.ValueName) = $OperatingSystemRegistryDetail.Value + } + } + } + + Default + { + $OperatingSystemDetailsTable.$($OperatingSystemRegistryDetail.ValueName) = $OperatingSystemRegistryDetail.Value + } + } + } + + ForEach ($OperatingSystemDetail In $OperatingSystemDetailsTable.GetEnumerator()) + { + $WriteLogMessage.Invoke(0, @("Operating System $($OperatingSystemDetail.Key): $($OperatingSystemDetail.Value)")) + } + #endregion + + #region Get the values of Windows special folders + $SpecialFolderNameList = [System.Enum]::GetNames('System.Environment+SpecialFolder') | Sort-Object + + $SpecialFolderDictionary = New-Object -TypeName 'System.Collections.Generic.Dictionary[[System.String], [System.String]]' + + ForEach ($SpecialFolderName In $SpecialFolderNameList) + { + $SpecialFolderPath = [System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::$($SpecialFolderName)) + + Switch (([System.String]::IsNullOrEmpty($SpecialFolderPath) -eq $False) -or ([System.String]::IsNullOrWhiteSpace($SpecialFolderPath) -eq $False)) + { + {($_ -eq $True)} + { + $SpecialFolderDictionary.$($SpecialFolderName) = [System.IO.DirectoryInfo][System.IO.Path]::Combine($SpecialFolderPath) + } + + Default + { + $SpecialFolderDictionary.$($SpecialFolderName) = [System.IO.DirectoryInfo][System.IO.Path]::Combine($Env:SystemDrive, 'DoesNotExist') + } + } + } + #endregion + + #region Log hardware information + $MSSystemInformationMembers = $MSSystemInformation.PSObject.Properties | Where-Object {($_.MemberType -imatch '^NoteProperty$|^Property$') -and ($_.Name -imatch '^Base.*|Bios.*|System.*$') -and ($_.Name -inotmatch '^.*Major.*|.*Minor.*|.*Properties.*$')} | Sort-Object -Property @('Name') + + Switch ($MSSystemInformationMembers.Count -gt 0) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Attempting to display device information properties from the `"$($MSSystemInformation.CimSystemProperties.ClassName)`" WMI class located within the `"$($MSSystemInformation.CimSystemProperties.Namespace)`" WMI namespace. Please Wait...")) + + ForEach ($MSSystemInformationMember In $MSSystemInformationMembers) + { + [String]$MSSystemInformationMemberName = ($MSSystemInformationMember.Name) + [String]$MSSystemInformationMemberValue = $MSSystemInformation.$($MSSystemInformationMemberName) + + Switch ([String]::IsNullOrEmpty($MSSystemInformationMemberValue)) + { + {($_ -eq $False)} + { + $WriteLogMessage.Invoke(0, @("$($MSSystemInformationMemberName) = $($MSSystemInformationMemberValue)")) + } + } + } + } + + Default + { + $WriteLogMessage.Invoke(2, @("The `"MSSystemInformation`" WMI class could not be found.")) + } + } + #endregion + + #region Network Adapter and Interface Information + [ScriptBlock]$GetNetworkConnectionInformation = { + $NetworkInterfaceObjectList = New-Object -TypeName 'System.Collections.Generic.List[PSObject]' + + $NetworkIsAvailable = [System.Net.NetworkInformation.NetworkInterface]::GetIsNetworkAvailable() + + $WriteLogMessage.Invoke(0, @("Network Connection Is Available: $($NetworkIsAvailable)")) + + Switch ($NetworkIsAvailable) + { + {($_ -eq $True)} + { + $NetworkInterfaceList = [System.Net.NetworkInformation.NetworkInterface]::GetAllNetworkInterfaces() | Where-Object {($_.NetworkInterfaceType -imatch 'Ethernet.*|Wireless.*') -and ($_.OperationalStatus -iin @('Up'))} + + $NetworkInterfaceListCount = ($NetworkInterfaceList | Measure-Object).Count + + $WriteLogMessage.Invoke(0, @("Detected $($NetworkInterfaceListCount) network interfaces that are Ethernet or Wireless and have an operational status of `"Up`".")) + + Switch ($NetworkInterfaceListCount -gt 0) + { + {($_ -eq $True)} + { + $NetworkIsConnected = $True + + For ($NetworkInterfaceListIndex = 0; $NetworkInterfaceListIndex -lt $NetworkInterfaceListCount; $NetworkInterfaceListIndex++) + { + $NetworkInterface = $NetworkInterfaceList[$NetworkInterfaceListIndex] + + $NetworkInterfaceProperties = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary' + $NetworkInterfaceProperties.InterfaceName = $Null + $NetworkInterfaceProperties.Description = $Null + $NetworkInterfaceProperties.MACAddress = $Null + $NetworkInterfaceProperties.IPv4Address = $Null + $NetworkInterfaceProperties.IPv4SubnetMask = $Null + $NetworkInterfaceProperties.IPv4PrefixLength = $Null + $NetworkInterfaceProperties.IPv6Address = $Null + $NetworkInterfaceProperties.Status = $NetworkInterface.OperationalStatus + $NetworkInterfaceProperties.Type = $NetworkInterface.NetworkInterfaceType + + $NetworkInterfaceProperties.InterfaceName = $NetworkInterface.Name + + $NetworkInterfaceProperties.Description = $NetworkInterface.Description + + $NetworkInterfaceMACAddress = If ($NetworkInterface.GetPhysicalAddress() -imatch '.*\:.*') {$NetworkInterface.GetPhysicalAddress()} Else {($NetworkInterface.GetPhysicalAddress() -ireplace '([a-zA-Z0-9]{2,2})', '$1:').TrimEnd(':').ToUpper()} + $NetworkInterfaceProperties.MACAddress = $NetworkInterfaceMACAddress + + $NetworkInterfaceIPProperties = $NetworkInterface.GetIPProperties() + + ForEach ($Address In $NetworkInterfaceIPProperties.UnicastAddresses) + { + Switch ($Address.Address.AddressFamily) + { + {($_ -imatch '(^InterNetwork$)')} + { + $NetworkInterfaceProperties.IPv4Address = ($Address.Address.IPAddressToString) + $NetworkInterfaceProperties.IPv4SubnetMask = ($Address.IPv4Mask) + $NetworkInterfaceProperties.IPv4PrefixLength = ($Address.PrefixLength) + } + + {($_ -imatch '(^InterNetworkV6$)')} + { + $NetworkInterfaceProperties.IPv6Address = ($Address.Address.IPAddressToString.ToUpper()) + } + } + } + + $NetworkInterfaceObject = New-Object -TypeName 'PSObject' -Property ($NetworkInterfaceProperties) + + $NetworkInterfaceObjectList.Add($NetworkInterfaceObject) + } + + $NetworkInterfaceObjectListCounter = 1 + + For ($NetworkInterfaceObjectListIndex = 0; $NetworkInterfaceObjectListIndex -lt $NetworkInterfaceObjectList.Count; $NetworkInterfaceObjectListIndex++) + { + $NetworkInterface = $NetworkInterfaceObjectList[$NetworkInterfaceObjectListIndex] + + $NetworkInterfacePropertyList = New-Object -TypeName 'System.Collections.Generic.List[String]' + + $Null = $NetworkInterface.PSObject.Properties | ForEach-Object {$NetworkInterfacePropertyList.Add("[$($_.Name): $($_.Value -Join ', ')]")} + + $WriteLogMessage.Invoke(0, @("Network Interface #$($NetworkInterfaceObjectListCounter.ToString('00')) - $($NetworkInterfacePropertyList -Join ' ')")) + + $NetworkInterfaceObjectListCounter++ + } + } + + Default + { + $NetworkIsConnected = $False + } + } + } + + Default + { + $NetworkIsConnected = $False + } + } + + Write-Output -InputObject ($NetworkIsConnected) + } + + $IsNetworkConnected = $GetNetworkConnectionInformation.Invoke() + #endregion + + #region Test Internet Connectivity + [ScriptBlock]$TestNetworkConnectivity = { + Param + ( + [System.URI]$NetworkConnectivityURI + ) + + Try + { + $Null = Add-Type -AssemblyName 'System.Net.Http' -IgnoreWarnings -Verbose:$False -ErrorAction SilentlyContinue + + $HTTPClientHandler = New-Object -TypeName 'System.Net.Http.HttpClientHandler' + $HTTPClientHandler.AllowAutoRedirect = $True + $HTTPClientHandler.UseDefaultCredentials = $True + $HTTPClientHandler.UseCookies = $True + + $HTTPClient = New-Object -TypeName 'System.Net.Http.HttpClient' -ArgumentList ($HTTPClientHandler) + $HTTPClient.Timeout = [System.TimeSpan]::FromSeconds(30) + + $WriteLogMessage.Invoke(0, @("Attempting to test network connectivity by sending an outbound HTTP(s) request over TCP to `"$($NetworkConnectivityURI)`". Please Wait...")) + + $HTTPResponse = $HTTPClient.GetAsync($NetworkConnectivityURI).GetAwaiter().GetResult() + + $HTTPResponseContent = $HTTPResponse.Content.ReadAsStringAsync().GetAwaiter().GetResult() + + $HTTPResponseContentTruncated = $HTTPResponseContent.Substring(0, [System.Math]::Min($HTTPResponseContent.Length, 256)) + + $WriteLogMessage.Invoke(0, @("Network Connectivity Test Succeeded: $($HTTPResponse.IsSuccessStatusCode)", "Network Connectivity Test Status: $($HTTPResponse.StatusCode)", "Network Connectivity Test Status Code: $($HTTPResponse.StatusCode.value__)")) + + Write-Output -InputObject ($HTTPResponse.IsSuccessStatusCode) + } + Catch + { + + } + Finally + { + $Null = Try {$HTTPClient.Dispose()} Catch {} + $Null = Try {$HTTPClientHandler.Dispose()} Catch {} + } + } + + $IsInternetConnected = $TestNetworkConnectivity.Invoke('https://www.google.com') + #endregion + + #region Log Cleanup + [Int]$MaximumLogHistory = 3 + + $LogList = Get-ChildItem -Path ($LogDirectory.FullName) -Filter "$($CallingScriptPath.BaseName)_*" -Recurse -Force | Where-Object {($_ -is [System.IO.FileInfo])} + + $SortedLogList = $LogList | Sort-Object -Property @('LastWriteTime') -Descending | Select-Object -Skip ($MaximumLogHistory) + + Switch ($SortedLogList.Count -gt 0) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("There are $($SortedLogList.Count) log file(s) requiring cleanup.")) + + For ($SortedLogListIndex = 0; $SortedLogListIndex -lt $SortedLogList.Count; $SortedLogListIndex++) + { + Try + { + $Log = $SortedLogList[$SortedLogListIndex] + + $LogAge = New-TimeSpan -Start ($Log.LastWriteTime.ToUniversalTime()) -End ([System.DateTime]::UtcNow) + + $WriteLogMessage.Invoke(0, @("Attempting to cleanup log file `"$($Log.FullName)`". Please Wait... [Last Modified: $($Log.LastWriteTime.ToString($DateTimeMessageFormat))] [Age: $($LogAge.Days.ToString()) day(s); $($LogAge.Hours.ToString()) hours(s); $($LogAge.Minutes.ToString()) minute(s); $($LogAge.Seconds.ToString()) second(s)].")) + + $Null = [System.IO.File]::Delete($Log.FullName) + } + Catch + { + + } + } + } + + Default + { + $WriteLogMessage.Invoke(0, @("There are $($SortedLogList.Count) log file(s) requiring cleanup.")) + } + } + #endregion + + #region Download And Install Dependency Package Provider(s) and Module(s) + $RequiredAssemblyList = New-Object -TypeName 'System.Collections.Generic.List[String]' + #$RequiredAssemblyList.Add('System.DirectoryServices') + #$RequiredAssemblyList.Add('System.Web') + + Switch ($RequiredAssemblyList.Count -gt 0) + { + {($_ -eq $True)} + { + ForEach ($RequiredAssembly In $RequiredAssemblyList) + { + $WriteLogMessage.Invoke(0, @("Attempting to load required assembly `"$($RequiredAssembly)`". Please Wait...")) + + $Null = Add-Type -AssemblyName ($RequiredAssembly) -ErrorAction Stop + } + } + } + #endregion + + #region Import Dependency Modules + If (($ModulesDirectory.Exists -eq $True) -and ($ModulesDirectory.GetDirectories().Count -gt 0)) + { + Switch ($ModulesDirectory.FullName.StartsWith('\\')) + { + {($_ -eq $True)} + { + $ModuleCacheRootDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($Env:Windir, 'Temp', 'PSMCache') + + $ModuleDirectoryList = $ModulesDirectory.GetDirectories() + + $ModuleDirectoryListCount = ($ModuleDirectoryList | Measure-Object).Count + + For ($ModuleDirectoryListIndex = 0; $ModuleDirectoryListIndex -lt $ModuleDirectoryListCount; $ModuleDirectoryListIndex++) + { + $ModuleDirectoryListItem = $ModuleDirectoryList[$ModuleDirectoryListIndex] + + $ModuleCacheDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($ModuleCacheRootDirectory.FullName, $ModuleDirectoryListItem.Name) + + Switch ([System.IO.Directory]::Exists($ModuleCacheDirectory.FullName)) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("Skipping the local cache of the powershell module `"$($ModuleDirectoryListItem.Name)`". [Reason: The powershell module has already been cached.]")) + } + + {($_ -eq $False)} + { + $WriteLogMessage.Invoke(0, @("Attempting to locally cache the powershell module `"$($ModuleDirectoryListItem.Name)`". Please Wait...")) + + If ([System.IO.Directory]::Exists($ModuleCacheDirectory.FullName) -eq $False) {$Null = [System.IO.Directory]::CreateDirectory($ModuleCacheDirectory.FullName)} + + $Null = Start-Sleep -Milliseconds 500 + + $NUll = Copy-Item -Path ([System.IO.Path]::Combine($ModuleDirectoryListItem.FullName, '*')) -Destination ([System.IO.Path]::Combine("$($ModuleCacheDirectory.FullName)$($DirectorySeparator)")) -Recurse -Force -Verbose:$False + } + } + } + + $ModulesDirectory = [System.IO.DirectoryInfo]$ModuleCacheRootDirectory.FullName + } + } + + $AvailableModules = Get-Module -Name ([System.IO.Path]::Combine($ModulesDirectory.FullName, '*')) -ListAvailable -ErrorAction Stop + + $AvailableModuleGroups = $AvailableModules | Group-Object -Property @('Name') + + ForEach ($AvailableModuleGroup In $AvailableModuleGroups) + { + $LatestAvailableModuleVersion = $AvailableModuleGroup.Group | Sort-Object -Property @('Version') -Descending | Select-Object -First 1 + + If ($Null -ine $LatestAvailableModuleVersion) + { + Switch ($LatestAvailableModuleVersion.RequiredModules.Count -gt 0) + { + {($_ -eq $True)} + { + $WriteLogMessage.Invoke(0, @("$($LatestAvailableModuleVersion.RequiredModules.Count) prerequisite powershell module(s) need to be imported before the powershell of `"$($LatestAvailableModuleVersion.Name)`" can be imported.")) + + $WriteLogMessage.Invoke(0, @("Prequisite Module List: $($LatestAvailableModuleVersion.RequiredModules.Name -Join '; ')")) + + ForEach ($RequiredModule In $LatestAvailableModuleVersion.RequiredModules) + { + Switch ($RequiredModule.Name -iin $AvailableModules.Name) + { + {($_ -eq $True)} + { + Switch ($Null -ine (Get-Module -Name $RequiredModule.Name -ErrorAction SilentlyContinue)) + { + {($_ -eq $True)} + { + $RequiredModuleDetails = $AvailableModules | Where-Object {($_.Name -ieq $RequiredModule.Name)} + + $WriteLogMessage.Invoke(0, @("Attempting to import prerequisite powershell module `"$($RequiredModuleDetails.Name)`" [Version: $($RequiredModuleDetails.Version.ToString())]. Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Prerequisite Module Path: $($RequiredModuleDetails.ModuleBase)")) + + $Null = Import-Module -Name "$($RequiredModuleDetails.Path)" -Global -DisableNameChecking -Force -ErrorAction Stop + } + } + } + } + } + } + } + + $WriteLogMessage.Invoke(0, @("Attempting to import dependency powershell module `"$($LatestAvailableModuleVersion.Name)`" [Version: $($LatestAvailableModuleVersion.Version.ToString())]. Please Wait...")) + + $WriteLogMessage.Invoke(0, @("Module Path: $($LatestAvailableModuleVersion.Path)")) + + $Null = Import-Module -Name "$($LatestAvailableModuleVersion.Path)" -Global -DisableNameChecking -Force + } + } + } + #endregion + + #region Dot Source Dependency Scripts + Switch ($FunctionsDirectory.Exists) + { + {($_ -eq $True)} + { + $AdditionalFunctionsFilter = New-Object -TypeName 'System.Collections.Generic.List[String]' + $AdditionalFunctionsFilter.Add('*.ps1') + + $AdditionalFunctionsToImport = Get-ChildItem -Path "$($FunctionsDirectory.FullName)" -Include ($AdditionalFunctionsFilter) -Recurse -Force -ErrorAction SilentlyContinue| Where-Object {($_ -is [System.IO.FileInfo])} + + $AdditionalFunctionsToImportCount = ($AdditionalFunctionsToImport | Measure-Object).Count + + Switch ($AdditionalFunctionsToImportCount -gt 0) + { + {($_ -eq $True)} + { + $AdditionalFunctionsToImportCounter = 1 + + For ($AdditionalFunctionsToImportIndex = 0; $AdditionalFunctionsToImportIndex -lt $AdditionalFunctionsToImportCount; $AdditionalFunctionsToImportIndex++) + { + $AdditionalFunctionToImport = $AdditionalFunctionsToImport[$AdditionalFunctionsToImportIndex] + + $WriteLogMessage.Invoke(0, @("Attempting to dot source the functions contained within the dependency script $($AdditionalFunctionsToImportCounter) of $($AdditionalFunctionsToImportCount). Please Wait... [Path: `"$($AdditionalFunctionToImport.FullName)`"]")) + + . "$($AdditionalFunctionToImport.FullName)" + + $AdditionalFunctionsToImportCounter++ + } + } + } + } + } + #endregion + + #region Load any required libraries + $LibariesDirectory = [System.IO.DirectoryInfo][System.IO.Path]::Combine($FunctionsDirectory.FullName, 'Libraries') + + Switch ([System.IO.Directory]::Exists($LibariesDirectory.FullName)) + { + {($_ -eq $True)} + { + $LibraryPatternList = New-Object -TypeName 'System.Collections.Generic.List[String]' + #$LibraryPatternList.Add('ChilkatDotNet48.dll') + + Switch ($LibraryPatternList.Count -gt 0) + { + {($_ -eq $True)} + { + $LibraryList = Get-ChildItem -Path ($LibariesDirectory.FullName) -Include ($LibraryPatternList.ToArray()) -Recurse -Force | Where-Object {($_ -is [System.IO.FileInfo])} + + $LibraryListCount = ($LibraryList | Measure-Object).Count + + Switch ($LibraryListCount -gt 0) + { + {($_ -eq $True)} + { + For ($LibraryListIndex = 0; $LibraryListIndex -lt $LibraryListCount; $LibraryListIndex++) + { + $Library = $LibraryList[$LibraryListIndex] + + $WriteLogMessage.Invoke(0, @("Attempting to load assembly `"$($Library.FullName)`". Please Wait...")) + + Switch ($Library.BaseName) + { + {($_ -imatch '(^Chilkat.*$)')} + { + $Null = Add-Type -Path ($Library.FullName) + } + + Default + { + [Byte[]]$LibraryBytes = [System.IO.File]::ReadAllBytes($Library.FullName) + + $Null = [System.Reflection.Assembly]::Load($LibraryBytes) + } + } + } + } + } + } + } + } + } + #endregion + + #region Scriptblock to pause script execution + [ScriptBlock]$PauseScriptExecution = { + Param + ( + [System.TimeSpan]$Duration + ) + + $WriteLogMessage.Invoke(0, @("Attempting to pause script execution for $($Duration.TotalSeconds). Please Wait...")) + + $Null = Start-Sleep -Seconds ($Duration.TotalSeconds) + } + #endregion + + #region This should always be the last command of the toolkit + $WriteLogMessage.Invoke(0, @("All required functions, modules, libraries, and variables have been loaded from the toolkit successfully.")) + #endregion + } +Catch + { + $WriteLogMessage.Invoke(3, @("Some or all of the required functions, modules, libraries, and variables have failed to load from the toolkit. No further action will be taken.", "Message: $($_.Exception.Message)", "Code: $($_.InvocationInfo.Line)")) + + Throw + } +Finally + { + + } \ No newline at end of file diff --git a/Toolkit/Tools/All/Place_Additional_Tools_Here.txt b/Toolkit/Tools/All/Place_Additional_Tools_Here.txt new file mode 100644 index 0000000..fa7cc9c --- /dev/null +++ b/Toolkit/Tools/All/Place_Additional_Tools_Here.txt @@ -0,0 +1 @@ +### \ No newline at end of file