eNLib.psm1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 |
<#
.SYNOPSIS eN's support functions library. .DESCRIPTION most commonly required functions such as better logging support for scripts, forking information to screen and file, enchanced GUI controls such as input box, most common connection accelerators and CSV manipulation. .LINK https://w-files.pl .NOTES nExoR ::))o- version 220328 changes - 220328 get-CSVDelimiter universalized and TAB delim added for detection [1.3.30] major changes in write-log/start-logging fix to extract icon - incompatibilities between PS5 & PS7 quickEdit mode typedef tuning - 220321 loading in PS 7.x of icon extractor didn't work - 220301 write-log error handling fix [1.3.22] - 220203 fixed retuned values from mutlichoice [1.3.21] - 220202 multichoice for select-ADObject [1.3.2] - 210810 select-OrganizationalUnit replaced with select-ADObject and proxy function for backward compatibility [1.3.1] - 210609 set-QuickEditMode function [1.3.0] - 210524 fix to select-Directory - 210520 fixes to select-OU, new select-Directory,select-File [1.2.0] - 210507 write-log null detection fix [1.1.8], get-valueFromInputBox - 210430 covert-CSV2XLS #typedef - 210422 again fixes to exit - 210421 write-log $message fix - 210408 fixes to import-* function exit - 210402 write-log 3rd output init, get-valueFromInput fix - 210329 write-log init fix - 210321 select-OU extention - 210317 upgrade to CSVtoXLS, get-ValueFromInput, delimiter detection, select-OU - 210315 many changes to CSV functions, experimental import-XLS - 210309 proper pipelining for CSV convertion, get-AzureADConnectionStatus - 210308 select-OU, convert-XLS2CSV, convert-CSV2XLS - 210302 write-log fix, check-exoconnection ext - 210301 connect-azure fix - 210219 import-structuredCSV function added, with alias load-csv, fix to connect-azure - 210212 wl fix - 210210 write-log and start-logging init fix - 210209 get-answerBox changes, get-valueFromInputBox, wl fix - 210206 write-log accepts all unnamed parameters as messages - 210205 write-log fixes - 210202 tuned write-log and start-logging, fixes and logical separation. v0.9 - 201018 initialize #> #################################################### GENERAL function start-Logging { <# .SYNOPSIS initilizes log file under $logFile variable for write-log function. .DESCRIPTION all scripts require logging mechinism. write-log function forking each output to the screen and to the logfile is a very convinient way keeping all logs consistent with very nice host output. for those who use scripts with 'always verbose' paradigm meaning that while running a script you want to have information what is going on (on screen) and have it logged in case anything goes wrong. this function initilizes $logFiles variable creation, and initiates the log file itself. in order to ease the creation there are several ways of initilizing $logFile: - using write-log directly - from console host - from script - using start-logging function directly - no parameters - defaults to $ScriptRoot/Logs folder or user documents/Logs if run from console - using 'useProfile' - to store logs in User Documents/Logs directory - using 'logFolder' parameter to define particular folder for logs - using 'logFileName' - (exclusive to logFolder) presenting full path for the log or logfile name logFile name changes automatically when script name changes. you can use 'persistent' switch to make given logFile persistent for all scripts run later - this is especially important if you use externall calls (invoke-command or &) so they are still logging to the same single file. script initializes $logFiles array variable to keep tract on log file names run from different context. write-log creates simple [string]$LogFile variable so you can easly reference the log file name in your scripts. .EXAMPLE write-log using write-log will inderectly call start-logging function and initialize the log file with generic name, saved in 'Logs' subfolder under script run path or 'documents' folder if run directly from console. .EXAMPLE start-Logging -logFileName c:\temp\myLogs\somelog.log write-log 'test message' initializes the log file as c:\temp\myLogs\somelog.log . .EXAMPLE start-Logging -logFileName c:\temp\myLogs\somelog.log -persistent write-log 'test message' initializes the log file as c:\temp\myLogs\somelog.log and makes it persistent - all scripts run afterwards will use the same log file until cosonle is closed, or another start-logging with persistent flag is run again. this is important when using dot-sourcing or calls (& or invoke-command) to enforce sub-code to use the same logfile - otherwise will create a new log file. .EXAMPLE start-Logging -logFileName somelog.log write-log 'test message' initializes the log file as .\somelog.log . .EXAMPLE start-Logging -logFolder c:\temp\myLogs write-log 'test message' initializes the log file under c:\temp\myLogs\ folder with generic name containing script name and date. .EXAMPLE start-Logging -userProfilePath write-log 'test message' initializes the log file in Logs subfolder uder user profile path with generic name containing script name and date. .INPUTS None. .OUTPUTS log file under $logFile variable. .LINK https://w-files.pl .NOTES nExoR ::))o- version 220328 changes: - 220328 rewritten with many fixes, and mostly - supports multi-level calls. when calling script-from-script. persistent switch added which related to multi-level calls. - 210408 breaks - 210210 removing recurrency to write-log (loop elimination) - 210205 fixes to logfilename initialization - 210203 added 'logFolder' and proper log initilization when called indirectly - 210127 v1 - 201018 initialize #> [CmdletBinding(DefaultParameterSetName='FilePath')] param( #provide custom name or full file path for log file. [Parameter(ParameterSetName='FilePath',mandatory=$false,position=0)] [string]$logFileName, #create log file with automatic name in the user profile folder rather than script run path [Parameter(ParameterSetName='userProfile',mandatory=$false,position=0)] [alias('useProfile')] [switch]$userProfilePath, #similar to logFileName, but takes folder only and log file name is generic. [Parameter(ParameterSetName='Folder',mandatory=$false,position=0)] [string]$logFolder, #make this logFile persisent till the end of the PS Session or re-running start-Logging (write-log will not generate new name) [Parameter(mandatory=$false,position=1)] [switch]$persistent ) #prepare baseName of the logFile #main global object used to keep record if(-not $global:logFiles) { $global:logFiles = @() for($lvl = 0; $lvl -lt 10; $lvl++ ) { #yeah.. hardcoding such limits is a risk, but I assume script will not be nested/stacked more 1o times $global:logFiles += [PSCustomObject]@{ #need to be array as $script context is broken and to handle nested invocation need to keep seperate values logName = '' #actual logFile name declared persistent = $false #enforce all scripts to use this name until directly changed with start-logging lastScriptUsed = '' #name of the script that created the logFile } } } elseif( -not $persistent.IsPresent ) { if($LogFiles|? persistent) { Write-Host "start-logging has been initiated, but persistent log is set. use '-persistent' switch to overwrite." -ForegroundColor Yellow return } } $scriptCallStack = (Get-PSCallStack | Where-Object {$_.command -ne 'write-log' -and $_.command -ne 'start-logging' -and $_.ScriptName -notmatch "\.psm1$"} ) $runLevel = $scriptCallStack.count - 1 if( -not ($scriptCallStack | ? ScriptName) ) { #if run from console - set the logfile name as 'console' $scriptBaseName = 'console' } else { $scriptBaseName = ([System.IO.FileInfo]$scriptCallStack[0].ScriptName).basename #after removing write-log and start-logging from callStack, next is a script that called } $logFiles[$runLevel].lastScriptUsed = $scriptBaseName #dependently on the parameters prepare actual logFile name and folder switch($PSCmdlet.ParameterSetName) { 'userProfile' { $logFolder = [Environment]::GetFolderPath("MyDocuments") + '\Logs' $logFiles[$runLevel].logName = "{0}\_{1}-{2}.log" -f $logFolder,$scriptBaseName,$(Get-Date -Format yyMMddHHmm) } 'Folder' { $logFiles[$runLevel].logName = "{0}\_{1}-{2}.log" -f $logFolder,$scriptBaseName,$(Get-Date -Format yyMMddHHmm) } 'filePath' { if ( [string]::IsNullOrEmpty($logFileName) ) { #start-logging used without any parameters (default) if($scriptBaseName -eq 'console') { $logFolder = [Environment]::GetFolderPath("MyDocuments") + '\Logs' $logFiles[$runLevel].logName = "{0}\_{1}-{2}.log" -f $logFolder,$scriptBaseName,$(Get-Date -Format yyMMddHHmm) } else { $logFolder = "$(split-path $scriptCallStack[0].scriptname -Parent)\Logs" $logFiles[$runLevel].logName = "{0}\_{1}-{2}.log" -f $logFolder,$scriptBaseName,$(Get-Date -Format yyMMddHHmm) } } else { #$logFileName provided . it can be: 1. file, 2. folder, 3. fullpath if( [string]::isNullOrEmpty( (split-path $logFileName) ) ) { #no path - only file name if( $scriptBaseName -eq 'console' ) { #run directly from console $logFolder = [Environment]::GetFolderPath("MyDocuments") + '\Logs' } else { $logFolder = $MyInvocation.PSScriptRoot } } else { if( test-path $logFileName -PathType Container ) { #folder ...ups! write-host "$logFileName seems to be an existing folder. use 'logFolder' parameter or change log name. quitting." -ForegroundColor Red return } $logFolder = split-path $logFileName -Parent $logFileName = split-path $logFileName -Leaf } $logFiles[$runLevel].logName = "$logFolder\$logFileName" } } default { write-host -ForegroundColor Magenta 'very strange error' return } } if(-not (test-path $logFolder) ) { try{ New-Item -ItemType Directory -Path $logFolder -ErrorAction Stop|Out-Null write-host "$LogFolder created." } catch { write-error $_.exception break } } if($persistent.IsPresent) { $logFiles[$runLevel].Persistent = $true } else { $logFiles[$runLevel].Persistent = $false } "*logging initiated $(get-date) in $($logFiles[$runLevel].logName)"|Out-File $logFiles[$runLevel].logName -Append write-host "*logging initiated $(get-date) in $($logFiles[$runLevel].logName)" "*script parameters:"|Out-File $logFiles[$runLevel].logName -Append if($script:PSBoundParameters.count -gt 0) { $script:PSBoundParameters|Out-File $logFiles[$runLevel].logName -Append } else { "<none>"|Out-File $logFiles[$runLevel].logName -Append } "***************************************************"|Out-File $logFiles[$runLevel].logName -Append } function write-log { <# .SYNOPSIS replacement for tee-object and write-host, forking information to a log file and screen (and possibly to third object), with flexible log initialization and colouring. .DESCRIPTION function has been developed with a paradigm 'always verbose' - if you need to see script run, and same time have it in a log file. it automates forking of output on two different endpoints - on the host, using write-host and to the file, appening its content, similarly to tee-object, but adds more options like message tag (error, info, warning) with cloured output and timestamps. ...actually there is option to fork on third source, described later... write-log converts everything to a string, so you can use it for virtually any type of variable - including objects. in order to use write-log, $logFiles variable requires to be set up. you can initialize the value directly with 'start-Logging', configure $logFile manually or simply run write-log to have it initialized automatically. by default logs are stored in $PSScriptRoot/Logs directory with generic file name. if you need special location refer to start-logging help how to initialize variable. function may also be used directly from command line - in this scenario log file will be created in Logs directory under User Documents folder. file with be named 'console-<date>.log'. THIRD OBJECT third object was introduced to help developing GUI apps and ability to show log on Forms elements, but may be used for regular strings as well and may be easily extended on other types. referenced objects must be provided as '([ref]$OBJECTNAME)' - with parenthesis and [ref]. as example, lets assume you have a Forms Label to show progress: $LabelStatus = New-Object System.Windows.Forms.Label you can then use write-log to fork on the screen, the file and show it on the label: write-log "something happens" -type info -thirdOutput $labelStatus GLOBAL VARIABLES start-logging initializes $logFiles variable which is an array, allowing to store different log file names for scripts run on different stack levels (when you do dot sourcing, &, invokes etc). this variable persists gloabally so the next script has 'a memory' to reuse the name. write-log creates simple [string]$logFile globally so you can easily reference the name in your srcipts e.g.: write-log "script run finished. check $logFile for details" -type ok .EXAMPLE write-log "all is fine" output '<timestamp> all is fine' on the screen and to the log file. .EXAMPLE write-log all is fine -skip outputs all is fine on the screen and to the log file - all unnamed parameters are displayed .EXAMPLE write-log -message "trees`nare`ngreen" -type ok shows: '<timestamp> OK: trees are green' in Green colour, and send text to a log file. .EXAMPLE start-Logging -logFileName ("{0}{1}{2}{3}{4}{5}" -f $PSScriptRoot,'\Logs\_',$env:USERNAME,'myScript-',$(Get-Date -Format yyMMddHHmm),'.log') write-log -message $someObject -type info if you need to create a logfile with some custom name or location - just use 'start-Logging' function which initializes logfile with required values. .EXAMPLE $someObject=get-process write-log -message $someObject -type info -skipTimeStamp -silent outputs processes object to the log file as -silent disables screen output. it will lack timestamp in a message header but will contain 'INFO:' block. .INPUTS None. .OUTPUTS text log file under $logFile .LINK https://w-files.pl .NOTES nExoR ::))o- version 220328 changes: - 220328 rewritten with many fixes, and mostly - supports multi-level calls. when calling script-from-script. skipTimeStamp changed to noTimeStamp. - 220301 error handling for add-content - issue found when trying to write to network drives and timeout occurs. - 210526 ...saga with catching $null continues - 210507 rare issue with message type check - 210421 interpreting $message elements fix - 210402 3rd output init - 210329 write-log init fix - 210302 do not convert to 'out-string' when it's already a string - 210212 imporper name when calling from console thru module - 210210 v2. init finally works! - 210209 when initialized on console, wl was not creating script log and using console file. - 210209 init from console fix - 210206 valueFromRemainingArguments - 210205 fix when run directly from console, init fixes - 210203 properly initiating log with new start-logging, when called indirectly - 210127 v1 - 201018 initialize #TO|DO - colouring codes for text - change screen text colour on ** <y></y> <r></r> <g></g> #> #DO NOT ADD 'parameter' data as it will break ValueFromRemainingArgs taking over numbered parameters param( #message to display - can be an object [parameter(ValueFromRemainingArguments=$true,mandatory=$false,position=0)] $message, #adds description and colour dependently on message type [string][validateSet('error','info','warning','ok')]$type, #do not output to a screen - logfile only [switch]$silent, # do not show timestamp with the message [Alias('skipTimestamp')] [switch]$noTimeStamp, #experimantal - 3rd output object so you can add virtually anything that accepts text to be set to. [ref][alias('thirdOutput')]$externallyReferencedObject ) #region INIT_LOG_FILE_NAME #0. no logFile - new #1. logfile & persistent - keep the same # logfile and not persisent: # 2. different script name - new # 3. same script and the same level (invocations) - keep the same # 4. same script but different level - new $scriptCallStack = (Get-PSCallStack | Where-Object {$_.command -ne 'write-log' -and $_.command -ne 'start-logging' -and $_.ScriptName -notmatch "\.psm1$"} ) $runLevel = $scriptCallStack.count - 1 #$scriptCallStack|fl|Out-Host $scriptBaseName = ([System.IO.FileInfo]$scriptCallStack[0].ScriptName).basename if( $logFiles ) { #$logFiles already initialized if( -not ($logFiles | Where-Object persistent) ) { #logFiles set but not Persistent if([string]::isNullOrEmpty($scriptBaseName)) { #run directly from console $scriptBaseName = 'console' } if($logFiles[$runLevel].lastScriptUsed -ne $scriptBaseName) { #logFiles exists and for the same script - check if the same level start-Logging } $LogFile = $logFiles[$runLevel].logName } else { #if persisent - then don't generate new $LogFile = ($logFiles | Where-Object persistent).logName } } else { #no $logFiles - create new start-Logging $LogFile = $logFiles[$runLevel].logName } #endregion INIT_LOG_FILE_NAME #ensure that whatever the type is - array, object.. - it will be output as string, add runtime if($null -eq $message) { $message='' } else { #ValueFromRemainingArguments changes how variable is presented. running "write-log 'output text'" will pass 'output text' as a "List`1" object #as that's how 'valueFromRemainingArguments' is bulding variable and ruturns an array. but if passed directly with "write-log -message 'output text'" #retruns true type of the passed variable - in this case [string]. try { switch( $message.GetType().name ) { 'List`1' { for($count=0;$count -lt $message.count;$count++) { if($message[$count].GetType().name -ne 'string') { $message[$count]=($message[$count]|out-String).trim()+"`n" } else { $message[$count]+=' ' } } $message=$message -join '' } 'String' { #do nothing - string is fine. } 'Default' { ($message|out-String).trim()+"`n" } } } catch { #there simply is no way to catch all nulls - any type of comparison generates exceptions. $message='' } } #region 3rdOUTPUT if($externallyReferencedObject) { if($externallyReferencedObject.Value.GetType().FullName -match 'System.Windows.Forms') { if($externallyReferencedObject.Value.multiline) { $externallyReferencedObject.Value.Text += "$message`n`r" } else { $externallyReferencedObject.Value.Text = $message } $externallyReferencedObject.Value.refresh() } else { $externallyReferencedObject.Value = $message } } #endregion 3rdOUTPUT #region FILE_OUTPUT try { $finalMessageString=@() if(-not $noTimestamp) { $finalMessageString += "$(Get-Date -Format "hh:mm:ss>") " } if(-not [string]::IsNullOrEmpty( $type) ) { $finalMessageString += $type.ToUpper()+": " } $finalMessageString += $message $message=$finalMessageString -join '' try { Add-Content -Path $LogFile -Value $message -ErrorAction Stop $global:logFile = $logFile } catch { "ERROR WRITING TO LOG FILE: $($_.exception)" | out-host } if(-not $silent) { switch($type) { 'error' { write-host -ForegroundColor Red $message } 'info' { Write-Host -ForegroundColor DarkGray $message } 'warning' { Write-Host -ForegroundColor Yellow $message } 'ok' { Write-Host -ForegroundColor Green $message } default { Write-Host $message } } } } catch { Write-Error 'not able to write to log. suggest to cancel the script run.' $_.exception } #endregion FILE_OUTPUT } function get-CSVDelimiter { param( [string]$inputCSV ) #header check - at least 2 lines required $FirstLines = Get-Content $inputCSV -Head 3 if($FirstLines[0] -match '^#') { #comments and #TYPE defs from export - skip $FirstLines=$FirstLines[1..2] } if($FirstLines.count -lt 2) { write-log "$inputCSV is not proper stuctured CSV - at least 2 lines expected (header and data)." -type error return $null } #this is very simple delimiter check based on number of columns in two first lines $FirstLines=$FirstLines -replace '''.*?''|".*?"','ANTI-DELIMITER' #change all quoted strings to simple string to avoid quoted delimiter characters $delims=@(",",";","`t") $current = ',' $maxCount = 0 foreach($delimiter in $delims) { $fl = $FirstLines[0].split($delimiter).Length - 1 $sl = $FirstLines[1].split($delimiter).Length - 1 if( ($sl - $fl) -eq 0 ) { if( $maxCount -lt $fl ) { $maxCount = $fl $current = $delimiter } } } write-log "'$current' detected as delimiter." -type info return $current } function import-structuredCSV { <# .SYNOPSIS loads CSV file with header check and auto delimiter detection .DESCRIPTION support function to gather data from CSV file with ability to ensure it is correct CSV file by enumerating header. if you operate on data you need to ensure that it is CORRECT file, and not some random CSV. extremally usuful in the projects when you use xls/csv as data providers and need to ensure that you stick to the standard column names. with non-critical header function allows to add missing columns. .EXAMPLE $inputCSV = "c:\temp\mydata.csv" $header=@('column1','column2') $data = load-CSV -header $header -headerIsCritical -delimiter ';' -inputCSV $inputCSV .LINK https://w-files.pl .NOTES nExoR ::))o- version 210421 last changes - 210421 exit/return/break tuning - 210317 delimiter detection as function - 210315 finbished auto, non-terminating from console, header not mandatory - 210311 auto delimiter detection, min 2lines - 210219 initialized #TO|DO - add nonCritical header + crit header handling - silent mode #> param( #path to CSV file containing data [parameter(mandatory=$true,position=0)] [string]$inputCSV, #expected header [parameter(mandatory=$false,position=1)] [string[]]$header, #this flag causes exit on load if any column is missing. [parameter(mandatory=$false,position=2)] [switch]$headerIsCritical, #CSV delimiter if different then regional settings. auto - tries to detect between comma and semicolon. uses comma if failed. [parameter(mandatory=$false,position=3)] [string]$delimiter='auto' ) if(-not (test-path $inputCSV) ) { write-log "$inputCSV not found." -type error return } if($delimiter='auto') { $delimiter=get-CSVDelimiter -inputCSV $inputCSV if($null -eq $delimiter) { return } } try { $CSVData=import-csv -path "$inputCSV" -delimiter $delimiter -Encoding UTF8 } catch { Write-log "not able to import $inputCSV. $($_.exception)" -type error return } $csvHeader=$CSVData|get-Member -MemberType NoteProperty|select-object -ExpandProperty Name $hmiss=@() foreach($el in $header) { if($csvHeader -notcontains $el) { Write-log """$el"" column missing in imported csv" -type warning $hmiss+=$el } } if($hmiss) { if($headerIsCritical) { Write-log "Wrong CSV header. check delimiter used. quitting." -type error return } $ans=Read-Host -Prompt "some columns are missing. type 'add' to add them, 'c' to continue or anything else to cancel" switch($ans) { 'add' { foreach($newCol in $hmiss) { $CSVData|add-member -MemberType NoteProperty -Name $newCol -value '' } write-log "header extended" -type info } 'c' { write-log "continuing without header change" -type info } default { write-log "cancelled. exitting." -type info return } } } return $CSVData } set-alias -Name load-CSV -Value import-structuredCSV function convert-XLStoCSV { <# .SYNOPSIS export all tables in XLSX files to CSV files. enumerates all sheets, and each table goes to another file. if sheet does not contain table - whole sheet is saved as csv .DESCRIPTION if file contain information out of table objects - they will be exported as a whole worksheet. files will be named after the sheet name + table/worksheet name and placed in seperate directory. separate script with ability to drang'n'drop may be downloaded from https://github.com/nExoRek/eN-Lib/blob/master/convert-XLSX2CSV.ps1 .EXAMPLE convert-XLS2CSV -fileName .\myFile.xlsx extracts tables/worksheets to CSV files under folder named after file .EXAMPLE ls *.xlsx | convertTo-CSVFromXLS converts all xlsx file in current directory to series of CSVs. .INPUTS XLSX file. .OUTPUTS Series of CSV files representing tables and/or worksheets (if lack of tables). .LINK https://w-files.pl .LINK https://github.com/nExoRek/eN-Lib/blob/master/convert-XLSX2CSV.ps1 drag'n'drop version - separate file. .NOTES nExoR ::))o- version 210422 last changes - 210422 ...again fixes to exit/break/return - 210408 proper 'run from console' detection and exit - 210317 firstWorksheet, suppress directory creation info - 210315 error detection during creation - 210309 proper pipeline - 210308 module function - 201121 output folder changed, descirption, do not export hidden by default, saveAs CSVUTF8 - 201101 initialized TO|DO - explore silent mode #> [cmdletbinding()] param( # XLSX file name to be converted to CSV files [Parameter(ParameterSetName='byName',mandatory=$true,position=0,ValueFromPipeline)] [string]$XLSfileName, # XLSX file object to be converted to CSV files [Parameter(ParameterSetName='byObject',mandatory=$true,position=0,ValueFromPipeline)] [System.IO.FileInfo]$XLSFile, #export only first worksheet, not all [Parameter(mandatory=$false,position=1)] [switch]$firstWorksheetOnly, #include hidden worksheets? [Parameter(mandatory=$false,position=2)] [switch]$includeHiddenWorksheets ) begin { try{ $Excel = New-Object -ComObject Excel.Application } catch { write-log "not able to initialize Excel lib. requires Excel to run.`n$($_.exception)" -type error break } $Excel.Visible = $false $Excel.DisplayAlerts = $false } process { if($PSCmdlet.ParameterSetName -eq 'byName') { if(-not (test-path $XLSFileName)) { write-log "$XLSfileName not found. exitting" -type error return } $XLSFile=get-Item $XLSfileName } if($XLSFile.Extension -notmatch '\.xls') { write-log "$($XLSFile.Name) doesn't look like excel file. exitting" -type error return } $outputFolder=$XLSFile.DirectoryName+'\'+$XLSFile.BaseName+'.exported' if( -not (test-path($outputFolder)) ) { new-Item -ItemType Directory $outputFolder|Out-Null } $workBookFile = $Excel.Workbooks.Open($XLSFile) #excel file save statics $fileType=62 #CSVUTF8 https://docs.microsoft.com/en-us/office/vba/api/excel.xlfileformat $localLanguage=$true write-log "converting $($XLSFile.Name) tables to CSV files..." -type info $CSVFileList=@() foreach($worksheet in $workBookFile.Worksheets) { if($worksheet.Visible -eq $false -and -not $includeHiddenWorksheets.IsPresent) { write-log "worksheet $($worksheet.name) found but it is hidden. use -includeHiddenWorksheets to export" -type info continue } Write-log "found worksheet: $($worksheet.name)" -type info $tableList=$worksheet.listObjects|Where-Object SourceType -eq 1 if($tableList) { foreach($table in $tableList ) { Write-log "found table $($table.name) on $($worksheet.name)" -type info $exportFileName=$outputFolder +'\'+($worksheet.name -replace '[^\w\d\-_\.]', '') + '_' + ($table.name -replace '[^\w\d]', '') + '.csv' $tempWS=$workBookFile.Worksheets.add() $table.range.copy()|out-null $tempWS.paste($tempWS.range("A1")) $tempWS.SaveAs($exportFileName, $fileType,$null,$null,$null,$null,$sddToMRU,$null,$null,$localLanguage) write-log "$($table.name) saved as $exportFileName" $tempWS.delete() Remove-Variable -Name tempWS $CSVFileList += get-Item $exportFileName } } else { Write-log "$($worksheet.name) does not contain tables. exporting whole sheet..." -type info $exportFileName=$outputFolder +'\'+($worksheet.name -replace '[^a-zA-Z0-9\-_]', '') + '_sheet.csv' $worksheet.SaveAs($exportFileName, $fileType,$null,$null,$null,$null,$sddToMRU,$null,$null,$localLanguage) write-log "worksheet $($worksheet.name) saved as $exportFileName" $CSVFileList += get-Item $exportFileName } if($firstWorksheetOnly) { break } } $Excel.Workbooks.Close() } end { $Excel.Quit() #any method of closing Excel file is not working 1oo% there are scenarios where excel process stays in memory. #Remove-Variable -name workBookFile #Remove-Variable -Name excel #[gc]::collect() #[gc]::WaitForPendingFinalizers() #https://social.technet.microsoft.com/Forums/lync/en-US/81dcbbd7-f6cc-47ec-8537-db23e5ae5e2f/excel-releasecomobject-doesnt-work?forum=ITCG while( [System.Runtime.Interopservices.Marshal]::ReleaseComObject($Excel) ){} Write-log "done and cleared." -type ok return $CSVFileList } } Set-Alias -Name convert-XLS2CSV -Value convert-XLStoCSV function convert-CSVtoXLS { <# .SYNOPSIS Converts CSV file into XLS with table. .DESCRIPTION creates XLXS out of CSV file and formats data as a table. .EXAMPLE convert-CSV2XLSX c:\temp\test.csv -delimiter ',' Converts test.csv to test.xlsx enforcing comma as delimiter in CSV interpretation .EXAMPLE ls *.csv | convert-CSV2XLS -outputFileName myfile.xlsx converts all csv files in current directory into sinlge xls file with multiple worksheets. .EXAMPLE start (convert-CSVtoXLS myfile.csv) convrts file and opens it in Excel .INPUTS CSV file or file name .OUTPUTS XLSX file. .LINK https://w-files.pl .NOTES nExoR ::))o- version 210430 last changes - 210430 #typedef skip - 210422 ...again fixes to exit/break/return - 210408 breaks - 210402 proper 'run from console' detection and exit - 210317 processing multiple CSV will create single XLS, delimiter autodetection, output file name - 210309 proper pipelining - 210308 module function - 201123 initialized TO|DO - add silent mode #> [CmdletBinding()] param ( #CSV file name to convert [Parameter(ParameterSetName='byName',mandatory=$true,position=0,ValueFromPipeline)] [string]$CSVfileName, #CSV file object to convert [Parameter(ParameterSetName='byObject',mandatory=$true,position=0,ValueFromPipeline)] [System.IO.FileInfo]$CSVfile, #output XLSX file name [Parameter(mandatory=$false,position=1)] [alias('outputFileName')] [string]$XLSfileName=$null, #style intensity [Parameter(mandatory=$false,position=2)] [alias('intensity')] [string][validateSet('Light','Medium','Dark')]$tableStyleIntensity='Medium', #style number [Parameter(mandatory=$false,position=3)] [alias('nr')] [int]$tableStyleNumber=21, #CSV delimiter character [Parameter(mandatory=$false,position=4)] [string]$delimiter='auto' ) begin { try{ $Excel = New-Object -ComObject Excel.Application } catch { write-log "not able to initialize Excel lib. requires Excel to run.`n$($_.Exeption)" -type error break } $Excel.Visible = $false $Excel.DisplayAlerts = $false $workbook = $excel.Workbooks.Add(1) $XLSfileList = @() $counter=0 if($delimiter -eq 'auto') { $autoDelimiter=$true } if(![string]::isNullOrEmpty($XLSfileName) ){ $parent = Split-Path $XLSfileName -Parent if([string]::isNullOrEmpty($parent)) { $XLSfileName = ($pwd).path +'\'+$XLSfileName } else { $XLSFileName = (Resolve-Path $parent).Path + '\' + (Split-Path $XLSfileName -Leaf) } if($XLSFileName -notmatch "\.xls[x]?") { $XLSfileName+=".xlsx" } write-log "creating $XLSfileName excel file..." -type info } } process { #$ErrorActionPreference="SilentlyContinue" #read CSV if($PSCmdlet.ParameterSetName -eq 'byName') { if(-not (test-path $CSVfileName) ) { write-host -ForegroundColor Red "file $CSVfileName is not accessible" return } #typedef skip from PSobjects $TYPEline = $false if((Get-Content $CSVfileName -Head 1) -match "^#") { $TYPEline = $true Get-Content $CSVfileName|select-object -Skip 1|Out-File "$CSVfileName-tmp" -Encoding utf8 $CSVFile=get-childItem "$CSVfileName-tmp" } else { $CSVFile=get-childItem $CSVfileName } } #convert output file name to full path if([string]::isNullOrEmpty($XLSfileName)) { $XLSfileName= ($pwd).path + '\' + $CSVFile.BaseName + '.xlsx' write-log "creating $XLSfileName excel file..." -type info } try { write-log "adding $($CSVfile.Name) data as worksheet..." -type info if($autoDelimiter) { $delimiter = get-CSVDelimiter -inputCSV $CSVfile.FullName if([string]::isNullOrEmpty($delimiter) ) { $delimiter=',' } } if($counter++ -gt 0) { $worksheet = $workbook.worksheets.add([System.Reflection.Missing]::Value,$workbook.Worksheets.Item($workbook.Worksheets.count)) } $worksheet = $workbook.worksheets.Item($workbook.Worksheets.count) $worksheet.name = $CSVfile.BaseName ### Build the QueryTables.Add command and reformat the data $TxtConnector = ("TEXT;" + $CSVFile.FullName) $Connector = $worksheet.QueryTables.add($TxtConnector,$worksheet.Range("A1")) $query = $worksheet.QueryTables.item($Connector.name) $query.TextFileOtherDelimiter = $delimiter $query.TextFileParseType = 1 $query.TextFileColumnDataTypes = ,1 * $worksheet.Cells.Columns.Count $query.AdjustColumnWidth = 1 $query.TextFilePlatform = 65001 ### Execute & delete the import query $query.Refresh() | out-null $range=$query.ResultRange $query.Delete() $Table = $worksheet.ListObjects.Add( [Microsoft.Office.Interop.Excel.XlListObjectSourceType]::xlSrcRange, $Range, "importedCSV", [Microsoft.Office.Interop.Excel.XlYesNoGuess]::xlYes ) <# TableStyle: - Light - Medium - Dark tableStyleNumber: - 1,8,15 black - 2,9,16 navy blue - 3,1o,17 orange - 4,11,18 gray - 5,12,19 yellow - 6,13,2o blue - 7,14,21 green #> $tableStyle=[string]"$tableStyleIntensity$tableStyleNumber" $Table.TableStyle = "TableStyle$tableStyle" #green with with gray shadowing } catch { write-log "error converting CSV to XLS: $($_.exception)" -type error return -2 } if($TYPEline) { remove-item "$CSVfileName-tmp" } } end { $errorSaving=$false try { $worksheet.SaveAs($XLSfileName, 51,$null,$null,$null,$null,$null,$null,$null,'True') #|out-null } catch { write-log "error saving $XLSfileName. $($_.exception)" -type error $errorSaving=$true } $workbook = $null $Excel.Workbooks.Close() $Excel.Quit() while( [System.Runtime.Interopservices.Marshal]::ReleaseComObject($Excel) ){} if(!$errorSaving) { write-log "convertion done, saved as $XLSfileName" $XLSfileList += (Get-Item $XLSfileName) Write-log "done and cleared." -type ok return $XLSfileList } else { return $null } } } Set-Alias -Name convert-CSV2XLS -Value convert-CSVtoXLS function import-XLS { <# .SYNOPSIS EXPERIMENTAL - importing XLS as table object, using convert+load .DESCRIPTION .INPUTS XLS file. .OUTPUTS table .LINK https://w-files.pl .NOTES nExoR ::))o- version 210317 last changes - 210317 use of firstWorksheet - 210315 initialized #TO|DO #> param( # XLSX file name to be converted to CSV files [Parameter(ParameterSetName='byName',mandatory=$true,position=0)] [string]$XLSfileName ) write-log "EXERIMAENTAL FUNCTION" -type warning $tempCSV = convert-XLStoCSV -XLSfileName $XLSfileName -firstWorksheetOnly if( $tempCSV ) { return (import-structuredCSV -inputCSV $tempCSV[0].FullName) } } function new-RandomPassword { <# .SYNOPSIS generate random password with given char ranges (complexity) and lenght .DESCRIPTION by default it genrates 8-long string with .EXAMPLE $pass = new-RandomPassword generated 8-char long semi-complex password .EXAMPLE $pass = new-RandomPassword -specialCharacterRange 3 generated 8-char long password with full complexity .INPUTS None. .OUTPUTS string of random characters .LINK https://w-files.pl .NOTES nExoR ::))o- version 210127 last changes - 210127 initialized #> param( #password length [Parameter(mandatory=$false,position=0)] [int]$length=8, #password complexity based on a range of special characters. [Parameter(mandatory=$false,position=1)] [int][validateSet(1,2,3)]$specialCharacterRange=1, #uniquness - related to complexity, recommended to leave. this guarantee that password will have characters from given number of char sets. [Parameter(mandatory=$false,position=2)] [int][validateSet(1,2,3,4)]$uniqueSets=4 ) function new-CharSet { param( # set up password length [int]$length, # number of 'sets of sets' defining complexity range [int]$setSize ) $safe=0 while ($safe++ -lt 100) { $array=@() 1..$length|ForEach-Object{ $array+=(Get-Random -Maximum ($setSize) -Minimum 0) } if(($array|Sort-Object -Unique|Measure-Object).count -ge $setSize) { return $array } else { Write-Verbose "[new-CharSet]bad array: $($array -join ',')" } } return $null } #prepare char-sets $smallLetters=$null 97..122|ForEach-Object{$smallLetters+=,[char][byte]$_} $capitalLetters=$null 65..90|ForEach-Object{$capitalLetters+=,[char][byte]$_} $numbers=$null 48..57|ForEach-Object{$numbers+=,[char][byte]$_} $specialCharacterL1=$null @(33;35..38;43;45..46;95)|ForEach-Object{$specialCharacterL1+=,[char][byte]$_} # !"#$%& $specialCharacterL2=$null 58..64|ForEach-Object{$specialCharacterL2+=,[char][byte]$_} # :;<=>?@ $specialCharacterL3=$null @(34;39..42;44;47;91..94;96;123..125)|ForEach-Object{$specialCharacterL3+=,[char][byte]$_} # [\]^` $ascii=@() $ascii+=,$smallLetters $ascii+=,$capitalLetters $ascii+=,$numbers if($specialCharacterRange -ge 2) { $specialCharacterL1+=,$specialCharacterL2 } if($specialCharacterRange -ge 3) { $specialCharacterL1+=,$specialCharacterL3 } $ascii+=,$specialCharacterL1 #prepare set of character-sets ensuring that there will be at least one character from at least $uniqueSets different sets $passwordSet = new-CharSet -length $length -setSize $uniqueSets $password=$NULL 0..($length-1)|ForEach-Object { $password+=($ascii[$passwordSet[$_]] | Get-Random) } return $password } function Set-QuickEditMode { <# .SYNOPSIS function allowing to disable/enable Quick Edit Mode for current PS host session. .DESCRIPTION accidental mouse-press on PS screen will lead to script pause. this is real problem - especially if you're providing scripts to unaware users. this simple function taken from CodeOverflow allows to control Quick Edit Mode setting for current PS host. this will allow to disable this feature before running the script. .EXAMPLE PS C:\> set-QuickEditMode -DisableQuickEdit disables Quick Edit mode for current PS Session .EXAMPLE PS C:\> set-QuickEditMode enables Quick Edit mode for current PS Session .LINK source code taken from: https://stackoverflow.com/questions/30872345/script-commands-to-disable-quick-edit-mode/42792718 .NOTES nExoR ::))o- version 210609 last changes - 210609 initialized #> param( [Parameter(Mandatory=$false)] [switch]$DisableQuickEdit ) add-type -TypeDefinition @" using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Runtime.InteropServices; public static class DisableConsoleQuickEdit { const uint ENABLE_QUICK_EDIT = 0x0040; // STD_INPUT_HANDLE (DWORD): -10 is the standard input device. const int STD_INPUT_HANDLE = -10; [DllImport("kernel32.dll", SetLastError = true)] static extern IntPtr GetStdHandle(int nStdHandle); [DllImport("kernel32.dll")] static extern bool GetConsoleMode(IntPtr hConsoleHandle, out uint lpMode); [DllImport("kernel32.dll")] static extern bool SetConsoleMode(IntPtr hConsoleHandle, uint dwMode); public static bool SetQuickEdit(bool SetEnabled) { IntPtr consoleHandle = GetStdHandle(STD_INPUT_HANDLE); // get current console mode uint consoleMode; if (!GetConsoleMode(consoleHandle, out consoleMode)) { // ERROR: Unable to get console mode. return false; } // Clear the quick edit bit in the mode flags if (SetEnabled) { consoleMode &= ~ENABLE_QUICK_EDIT; } else { consoleMode |= ENABLE_QUICK_EDIT; } // set the new mode if (!SetConsoleMode(consoleHandle, consoleMode)) { // ERROR: Unable to set console mode return false; } return true; } } "@ -Language CSharp if( [DisableConsoleQuickEdit]::SetQuickEdit($DisableQuickEdit) ) { Write-Log "QuickEdit settings has been updated." -type info } else { Write-Log "Something went wrong." -type info } } #################################################### PowerShell GUI function get-answerBox { <# .SYNOPSIS win32 forms message box to get YES/NO input from user .DESCRIPTION replacement for simple messageBox giving option to customize buttons, giving option to add some additional information .EXAMPLE $response = get-answerBox -OKButtonText 'YES' -CancelButtonText 'NO' -info 'choose your answer' -message 'do you find this function useful?' if($response) { write-host 'thank you!' } .INPUTS None. .OUTPUTS true/false .LINK https://w-files.pl .NOTES nExoR ::))o- version 210209 last changes - 210209 detailedInfo -> message (alias left for compatibility), autosize, anchors - 210208 icon, tune, info -> title - 210127 module - 210110 initialized #TO|DO #> param( #OK button text [Parameter(mandatory=$false,position=0)] [string]$OKButtonText = "OK", #Canel button text [Parameter(mandatory=$false,position=1)] [string]$CancelButtonText = "Cancel", #title bar text [Parameter(mandatory=$false,position=2)] [string]$title = "Which option?", #message text [Parameter(mandatory=$false,position=3)] [alias('detailedInfo')] [string]$message = "What is your choice:", #messagebox icon [Parameter(mandatory=$false,position=4)] [validateSet('Asterisk','Error','Exclamation','Hand','Information','None','Question','Stop','Warning')] [string]$icon='Question' ) Add-Type -AssemblyName System.Windows.Forms Add-Type -AssemblyName System.Drawing [System.Windows.Forms.Application]::EnableVisualStyles() $messageBoxForm = New-Object System.Windows.Forms.Form $messageBoxForm.Text = $title $messageBoxForm.Size = New-Object System.Drawing.Size(300,120) $messageBoxForm.AutoSize = $true $messageBoxForm.StartPosition = 'CenterScreen' $messageBoxForm.FormBorderStyle = 'Fixed3D' $messageBoxForm.Icon = [System.Drawing.SystemIcons]::$icon $messageBoxForm.Topmost = $true $messageBoxForm.MaximizeBox = $false $okButton = New-Object System.Windows.Forms.Button $okButton.Location = New-Object System.Drawing.Point(50,50) $okButton.Size = New-Object System.Drawing.Size(75,23) $okButton.Anchor = 'left,bottom' $okButton.Text = $OKButtonText $okButton.DialogResult = [System.Windows.Forms.DialogResult]::OK $messageBoxForm.AcceptButton = $okButton $messageBoxForm.Controls.Add($okButton) $cancelButton = New-Object System.Windows.Forms.Button $cancelButton.Location = New-Object System.Drawing.Point(160,50) $cancelButton.Size = New-Object System.Drawing.Size(75,23) $cancelButton.Anchor = 'right,bottom' $cancelButton.Text = $CancelButtonText $cancelButton.DialogResult = [System.Windows.Forms.DialogResult]::Cancel $messageBoxForm.CancelButton = $cancelButton $messageBoxForm.Controls.Add($cancelButton) $label = New-Object System.Windows.Forms.Label $label.Location = New-Object System.Drawing.Point(10,20) $label.AutoSize = $true $label.Anchor = 'left,top' $label.Text = $message $messageBoxForm.Controls.Add($label) $result = $messageBoxForm.ShowDialog() if ($result -eq [System.Windows.Forms.DialogResult]::OK) { return $true } return $false } function get-valueFromInputBox { <# .SYNOPSIS simple input message box function for PS GUI scripts .EXAMPLE $response = get-valueFromInputBox -title 'WARNING!' -text "type 'YES' to continue" -type Warning if($null -eq $response) { 'cancelled' exit 0 } if($response -ne 'YES') { 'not correct. quitting' exit } else { "you agreed, let's continue" } write-host 'code to execute here' .EXAMPLE $computerName = get-valueFromInbox -title 'Provide computer name' -maxChars 15 -allowedCharacters '[a-zA-Z0-9_-]' limit input to 15 characters and allow only letters,digits, underscore and minus. .INPUTS None. .OUTPUTS User Input or $null for cancel .LINK https://w-files.pl .NOTES nExoR ::))o- version 210402 last changes - 210507 maxChars fix - 210402 allowcharacter check worked for last character only. - 210317 allowCharacter - 210209 anchored layout - 210113 initialized #TO|DO #> param( [parameter(mandatory=$false,position=0)] [string]$title='input', [parameter(mandatory=$false,position=1)] [alias('text')] [string]$message='put your input', [parameter(mandatory=$false,position=2)] [validateSet('Asterisk','Error','Exclamation','Hand','Information','None','Question','Stop','Warning')] [string]$type='Question', #maximum number of characters allowed [Parameter(mandatory=$false,position=3)] [alias('maxChars')] [int]$maxCharacters = 30, #regular expression limiting characters -eg 'only digits' [Parameter(mandatory=$false,position=4)] [alias('regex')] [regex]$allowedCharacters ) Add-Type -AssemblyName System.Drawing Add-Type -AssemblyName System.Windows.Forms [System.Windows.Forms.Application]::EnableVisualStyles() $promptWindowForm = New-Object system.Windows.Forms.Form $promptWindowForm.Size = New-Object System.Drawing.Size(250,140) $promptWindowForm.text = $title $promptWindowForm.BackColor = "#ffffff" $promptWindowForm.AutoSize = $true $promptWindowForm.StartPosition = 'CenterScreen' $promptWindowForm.FormBorderStyle = 'Fixed3D' $promptWindowForm.MaximizeBox = $false $promptWindowForm.Icon = [System.Drawing.SystemIcons]::$type $promptWindowForm.Font = New-Object System.Drawing.Font('Microsoft Sans Serif', 10) $lblPromptInfo = New-Object System.Windows.Forms.Label $lblPromptInfo.Location = New-Object System.Drawing.Size(10,5) #$lblPromptInfo.Size = New-Object System.Drawing.Size(230,40) $lblPromptInfo.AutoSize = $true $lblPromptInfo.MinimumSize = New-Object System.Drawing.Size(235,10) $lblPromptInfo.Anchor = 'left,top' $lblPromptInfo.Text = $message $txtUserInput = New-Object system.Windows.Forms.TextBox $txtUserInput.multiline = $false $txtUserInput.ReadOnly = $false $txtUserInput.MinimumSize = New-Object System.Drawing.Size(230,25) $txtUserInput.autosize = $true $txtUserInput.Anchor = "none" #effectively - center $txtUserInput.MaxLength = $maxCharacters $txtUserInput.location = New-Object System.Drawing.Point(0, 35) $btOK = New-Object System.Windows.Forms.Button $btOK.Location = New-Object System.Drawing.Size(30,70) $btOK.Size = New-Object System.Drawing.Size(70,20) $btOK.ForeColor = "Green" $btOK.Anchor = "left,bottom" $btOK.Text = "Continue" $btOK.DialogResult = [System.Windows.Forms.DialogResult]::OK $btCancel = New-Object System.Windows.Forms.Button $btCancel.Location = New-Object System.Drawing.Size(150,70) $btCancel.Size = New-Object System.Drawing.Size(70,20) $btCancel.ForeColor = "Red" $btCancel.Anchor = "right,bottom" $btCancel.Text = "Cancel" $btCancel.DialogResult = [System.Windows.Forms.DialogResult]::Cancel $promptWindowForm.AcceptButton=$btOK $promptWindowForm.CancelButton=$btCancel $promptWindowForm.Controls.AddRange(@($lblPromptInfo, $txtUserInput,$btOK,$btCancel)) $promptWindowForm.Topmost = $true $promptWindowForm.Add_Shown( { $promptWindowForm.Activate();$txtUserInput.Select() }) $txtUserInput.add_KeyUp({ if($allowedCharacters -and $txtUserInput.text) { $cursor=$txtUserInput.SelectionStart if($txtUserInput.text[$cursor-1] -notmatch $allowedCharacters) { $tempText='' for($len=0;$len -lt $txtUserInput.text.Length;$len++) { if($len -ne $cursor-1) { $tempText+=$txtUserInput.text[$len] } } $txtUserInput.Text=$tempText $txtUserInput.Select($cursor-1, 0); } } }) $result = $promptWindowForm.ShowDialog() if ($result -eq [System.Windows.Forms.DialogResult]::OK) { $response = $txtUserInput.Text return $response } else { return $null } } function get-Icon { param( [int]$iconNumber, [string]$fileContaining = 'Shell32.dll' ) #icon extractor if($PSVersionTable.PSVersion.Major -le 5) { $ref = @('System.Drawing') } else { $ref = @('System.Drawing.Common','System.Runtime.InteropServices') } Add-Type -TypeDefinition @" using System; using System.Drawing; using System.Runtime.InteropServices; namespace System { public class IconExtractor { public static Icon Extract(string file, int number, bool largeIcon) { IntPtr large; IntPtr small; ExtractIconEx(file, number, out large, out small, 1); try { return Icon.FromHandle(largeIcon ? large : small); } catch { return null; } } [DllImport("Shell32.dll", EntryPoint = "ExtractIconExW", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.StdCall)] private static extern int ExtractIconEx(string sFile, int iIndex, out IntPtr piLargeVersion, out IntPtr piSmallVersion, int amountIcons); } } "@ -ReferencedAssemblies $ref return [System.IconExtractor]::Extract($fileContaining, $iconNumber, $true) } function select-Directory { <# .SYNOPSIS accelerator function allowing to select system directory with GUI. .DESCRIPTION function is using winforms treeView to display directory structure. returns folder path on select or folder object if 'object' parameter used. WARNING! text search looks up only for loaded branches. use 'loadAll' to be able to seach entire branch. best is to combine with 'startingDirectory' for performance reasons - loading whole disk structure may take a long, long time. .EXAMPLE cd (select-Directory) displays forms treeview enabling to choose directory using GUI and changes location .INPUTS None. .OUTPUTS directory name/object .LINK https://w-files.pl .NOTES nExoR ::))o- version 210524 last changes - 210524 fix to shortcut folders - 210521 optimization, tuning - 210519 initialized #TO|DO - multichoice #> [cmdletbinding()] param( #starting folder (tree root) [Parameter(mandatory=$false,position=0)] [string]$startingDirectory='\', #show hidden folders [Parameter(mandatory=$false,position=1)] [switch]$hidden, #include files [Parameter(mandatory=$false,position=2)] [switch]$files, #return directory path as string instead of 'folder object' [Parameter(mandatory=$false,position=3)] [switch]$object, #enable text search box - will load entire tree which might take time, but will allow to search thru entire tree. best used with -startingDirectory for subfolders [Parameter(mandatory=$false,position=4)] [switch]$loadAll ) Function add-Nodes { param( $node, [int]$localDepth=0 ) write-verbose "check $($node.tag.name)" if($node.tag.unfolded -eq $false -and $node.tag.type -eq 'DirectoryInfo') { write-verbose "addingNode $($node.tag.name)" $listParams = @{ ErrorAction = 'SilentlyContinue' Path = $node.tag.FullName } if(!$files.IsPresent) { $listParams.Add('Directory',$true) } if($hidden.IsPresent) { $listParams.Add("Force",$true) } $SubDirList = Get-ChildItem @listParams $lblLoading.Text = "Loading $($node.tag.name) ($($SubDirList.count) subs)..." $loading.refresh() $node.tag.unfolded = $true foreach ( $dir in $SubDirList ) { $NodeSub = $Node.Nodes.Add($dir.Name) $NodeSub.tag = [psobject]@{ fullName = $dir.FullName unfolded = $false name = $dir.name type = $dir.gettype().name } $script:NodeList += $NodeSub.tag } if($localDepth -gt 0) { foreach($SubNode in $node.Nodes) { add-Nodes -node $SubNode -localDepth ($localDepth - 1) } } } else { } } Add-Type -AssemblyName System.Drawing Add-Type -AssemblyName System.Windows.Forms [System.Windows.Forms.Application]::EnableVisualStyles() #region LOADINGFORM $loading = New-Object system.Windows.Forms.Form $loading.ClientSize = New-Object System.Drawing.Point(250, 30) $loading.StartPosition = 'CenterScreen' $loading.TopMost = $true $loading.Font = New-Object System.Drawing.Font("Microsoft Sans Serif", 10) $loading.ControlBox = $false $loading.FormBorderStyle = 'FixedSingle' $loading.padding = 0 $lblLoading = New-Object System.Windows.Forms.Label $lblLoading.Location = New-Object System.Drawing.Size(10,10) $lblLoading.Size = New-Object System.Drawing.Size(250,30) $loading.Controls.Add($lblLoading) $loading.add_Shown({ [System.windows.Forms.Application]::UseWaitCursor = $true [System.windows.Forms.Application]::DoEvents() }) $loading.add_Deactivate({ [System.windows.Forms.Application]::UseWaitCursor = $false [System.windows.Forms.Application]::DoEvents() }) #endregion LOADINGFORM #region FORM $formFolders = New-Object System.Windows.Forms.Form $formFolders.Text = "select Directory under $startingDirectory" $formFolders.MinimumSize = New-Object System.Drawing.Size(300,500) $formFolders.AutoSize = $true $formFolders.StartPosition = 'CenterScreen' $formFolders.Icon = [System.Drawing.SystemIcons]::Question $formFolders.Topmost = $true $formFolders.MaximizeBox = $false $formFolders.dock = "fill" #region shortcut_buttons $gbShortcuts = new-object system.windows.forms.groupBox $gbShortcuts.Text = 'Shortcuts' $gbShortcuts.Anchor = 'left,right' $gbShortcuts.autosize = $true $gbShortcuts.Padding = 0 $pbxDocument = New-Object System.windows.forms.pictureBox $pbxDocument.Location = New-Object System.Drawing.Point(10,13) $pbxDocument.Size = New-Object System.Drawing.Size(25,25) $pbxDocument.SizeMode = 'StretchImage' $pbxDocument.Image = get-Icon -iconNumber 1 $pbxDocument.add_Click({ $result.value = ([Environment]::GetFolderPath("MyDocuments")) $formFolders.DialogResult = [System.Windows.Forms.DialogResult]::OK $formFolders.Close() }) $pbxDownloads = New-Object System.Windows.Forms.pictureBox $pbxDownloads.Location = New-Object System.Drawing.Point(65,13) $pbxDownloads.Size = New-Object System.Drawing.Size(25,25) $pbxDownloads.SizeMode = 'StretchImage' $pbxDownloads.Image = get-Icon -iconNumber 122 $pbxDownloads.add_Click({ $result.value = ((New-Object -ComObject Shell.Application).NameSpace('shell:Downloads').Self.Path) $formFolders.DialogResult = [System.Windows.Forms.DialogResult]::OK $formFolders.Close() }) $pbxDesktop = New-Object System.Windows.Forms.pictureBox $pbxDesktop.Location = New-Object System.Drawing.Point(120,13) $pbxDesktop.Size = New-Object System.Drawing.Size(25,25) $pbxDesktop.SizeMode = 'StretchImage' $pbxDesktop.Image = get-Icon -iconNumber 34 $pbxDesktop.add_Click({ $result.value = ([Environment]::GetFolderPath("Desktop")) $formFolders.DialogResult = [System.Windows.Forms.DialogResult]::OK $formFolders.Close() }) $pbxTemp = New-Object System.Windows.Forms.pictureBox $pbxTemp.Location = New-Object System.Drawing.Point(175,13) $pbxTemp.Size = New-Object System.Drawing.Size(25,25) $pbxTemp.SizeMode = 'StretchImage' $pbxTemp.Image = get-Icon -iconNumber 35 $pbxTemp.add_Click({ $result.value = ($env:temp) $formFolders.DialogResult = [System.Windows.Forms.DialogResult]::OK $formFolders.Close() }) $gbShortcuts.controls.addRange(@($pbxDocument, $pbxDownloads, $pbxDesktop, $pbxTemp)) #endregion shortcut_buttons #regular Tree View component - after loading $treeView = New-Object System.Windows.Forms.TreeView $treeView.Dock = 'Fill' $treeView.CheckBoxes = $false $treeView.Name = 'treeView' $treeView.TabIndex = 1 #'shadow' Tree View component used during text search $SearchTreeView = New-Object System.Windows.Forms.TreeView $SearchTreeView.Dock = 'Fill' $SearchTreeView.CheckBoxes = $false $SearchTreeView.name = 'SearchTreeView' #region OKCANCEL $okButton = New-Object System.Windows.Forms.Button $okButton.Size = New-Object System.Drawing.Size(75,23) $okButton.Anchor = 'left' $okButton.Text = "OK" $okButton.Enabled = $false $okButton.DialogResult = [System.Windows.Forms.DialogResult]::OK $okButton.TabIndex = 3 $formFolders.AcceptButton = $okButton $okButton.add_Click({ $currentView=($mainTable.controls|Where-Object name -match 'treeView') if($currentView.name -eq 'treeView') { $result.value = $currentView.SelectedNode.tag.FullName } else { $result.value = $currentView.SelectedNode.text } $formFolders.close() }) $cancelButton = New-Object System.Windows.Forms.Button $cancelButton.Size = New-Object System.Drawing.Size(75,23) $cancelButton.anchor = 'right' $cancelButton.Text = "Cancel" $cancelButton.TabIndex = 4 $cancelButton.DialogResult = [System.Windows.Forms.DialogResult]::Cancel $formFolders.CancelButton = $cancelButton #endregion OKCANCEL $txtSearch = New-Object system.Windows.Forms.TextBox $txtSearch.multiline = $false $txtSearch.ReadOnly = $false $txtSearch.MinimumSize = new-object System.Drawing.Size(300,20) $txtSearch.Height = 20 $txtSearch.Font = New-Object System.Drawing.Font('Microsoft Sans Serif', 8) $txtSearch.Location = new-object System.Drawing.Point(3,3) $txtSearch.TabIndex = 2 $mainTable = New-Object System.Windows.Forms.TableLayoutPanel $mainTable.AutoSize = $true $mainTable.ColumnCount = 2 $mainTable.RowCount = 4 $mainTable.Dock = "fill" $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Absolute,50)) )|out-null $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Absolute,30)) )|out-null $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Percent,100)) )|out-null $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Absolute,30)) )|out-null $mainTable.Controls.add($gbShortcuts,0,0) $mainTable.SetColumnSpan($gbShortcuts,2) $mainTable.controls.Add($txtSearch,1,0) $mainTable.SetColumnSpan($txtSearch,2) $mainTable.Controls.Add($treeView,2,0) $mainTable.SetColumnSpan($treeView,2) $mainTable.Controls.add($okButton,3,0) $mainTable.Controls.add($cancelButton,3,1) $formFolders.Controls.Add($mainTable) $searchTimer = new-object System.Windows.Forms.Timer $searchTimer.Interval = 1000 #endregion FORM #region FORM_FUNCTIONS $formFolders.add_Load({ $toolTip = new-object System.Windows.Forms.ToolTip $toolTip.SetToolTip($pbxDocument,'My Documents') $toolTip.SetToolTip($pbxDownloads,'Downloads') $toolTip.SetToolTip($pbxDesktop,'Desktop') $toolTip.SetToolTip($pbxTemp,'Temp') if(!$loadAll.IsPresent) { $toolTip.SetToolTip($txtSearch,'directories are not fully loaded - results will be limited. check "loadAll" flag usage.') } $formFolders.refresh() }) $formFolders.add_Shown({ $initialDirectory = Get-Item $startingDirectory -force $rootNode = $treeView.Nodes.Add($initialDirectory.FullName) $rootNode.Tag=[psobject]@{ fullName = $initialDirectory.FullName unfolded = $false name = $initialDirectory.Name type = $initialDirectory.gettype().name } $DEPTH = 0 if($loadAll) { $DEPTH = 1000 write-log "LOADING FULL TREE (will take time)..." -type warning } add-Nodes $rootNode -localDepth $DEPTH $treeView.refresh() $formFolders.refresh() $treeView.nodes[0].Expand() }) $formFolders.add_Closing({ $loading.dispose() }) $txtSearch.add_gotFocus({ $okButton.Enabled = $false }) $txtSearch.add_KeyUp({ #param($sender,$e) $searchTimer.start() }) $searchTimer.add_Tick({ if($txtSearch.Text.Length -gt 1 -and ($mainTable.Controls|Where-Object name -eq 'treeView')) { $mainTable.Controls.Remove($treeView) $mainTable.controls.add($searchTreeView,2,0) $mainTable.SetColumnSpan($searchTreeView,2) $formFolders.Refresh() } if($txtSearch.Text.Length -le 1) { $mainTable.Controls.Remove($searchTreeView) $mainTable.Controls.Add($treeView,2,0) $formFolders.Refresh() } if($txtSearch.Text.Length -gt 1) { $searchTreeView.Nodes.Clear() foreach($n in $NodeList) { if($n.name -match $txtSearch.Text) { $searchTreeView.Nodes.Add($n.FullName) } } } $searchTimer.stop() }) $treeview.add_beforeExpand({ param($sender, $e) write-verbose "beforeExand: $($e.node.tag.name)" $treeView.SelectedNode = $e.node }) $treeview.add_afterSelect({ param($sender, $e) write-verbose "afterSelect: $($e.node.tag.name)" $okButton.Enabled = $true #$e.node.Expand() $loading.Show() foreach($subNode in $e.node.Nodes) { add-Nodes -node $subNode } $loading.Hide() [System.windows.Forms.Application]::UseWaitCursor = $false [System.windows.Forms.Application]::DoEvents() $formFolders.Focus() }) $SearchTreeView.add_afterSelect({ $okButton.Enabled = $true }) #endregion FORM_FUNCTIONS $script:NodeList=@() $result = @{ Value='' } $ret = $formFolders.ShowDialog() if($ret -eq [System.Windows.Forms.DialogResult]::OK) { if($object.IsPresent) { return (Get-Item $result.value -force) } else { return $result.value } } } function select-File { <# .SYNOPSIS wrapper function for select-directory with 'files' flag .NOTES nExoR ::))o- version 210520 last changes - 210520 initialized #TO|DO #> param( #starting folder (tree root) [Parameter(mandatory=$false,position=0)] [string]$startingDirectory='\', #show hidden folders [Parameter(mandatory=$false,position=1)] [switch]$hidden, #return directory path as string instead of 'folder object' [Parameter(mandatory=$false,position=2)] [switch]$object, #enable text search box - will load entire tree which might take time, but will allow to search thru entire tree. best used with -startingDirectory for subfolders [Parameter(mandatory=$false,position=3)] [switch]$loadAll ) select-Directory -files @PSBoundParameters } function select-ADObject { <# .SYNOPSIS accelerator function allowing to select OU with GUI. .DESCRIPTION function is using winforms treeView to display OU structure. returns DistinguishedName on select or OU object if 'object' parameter used. WARNING! text search looks up only for loaded branches. use 'loadAll' to be able to seach entire branch. best is to combine with 'startingOU' for performance reasons - loading whole AD structure may take a long time. .EXAMPLE $ou = select-OU displays forms treeview enabling to choose OU from the tree. .EXAMPLE new-ADUser -name 'some user' -path (select-OrganizationalUnit -start OU=LU,DC=w-files,DC=pl -loadAll) allows to select OU starting from OU=LU and preloading entire tree .EXAMPLE $ou = select-OU -object $ou.ObjectGUID returns full OU object instead of distinguishedName only. .INPUTS None. .OUTPUTS DistinguishedName .LINK https://w-files.pl .NOTES nExoR ::))o- version 220203 last changes - 220203 fixed how multichoice is returned - 220202 improvements - 220201 multichoice initial, load fixes - 210520 icons, load improvements, behaviour fixes - 210511 return object - 210321 loadAll - 210317 rootNode, disableRoot - 210308 initialized #TO|DO - [optimization] loading and viewing is very slow, using a lot of recursion and re-reading. especialy painful on slow DC connections. should use some caching mechanism... - [optimization] multichoice should use additional table to store chosen values - to quickly return values #> param( #starting OU (tree root) [Parameter(mandatory=$false,position=0)] [string]$startingOU=(get-ADRootDSE).defaultNamingContext, #root node can't be selected [Parameter(mandatory=$false,position=1)] [switch]$disableRoot, #return OU object instead of string name [Parameter(mandatory=$false,position=2)] [switch]$object, #enable text search box - will load entire tree which might take time, but will allow to search thru entire tree [Parameter(mandatory=$false,position=3)] [switch]$loadAll, # do not load leaf objects - only OU structure [Parameter(mandatory=$false,position=4)] [validateSet('computer','user','group','organizationalUnit')] [string]$filterObject, #enable multichoice [Parameter(mandatory=$false,position=5)] [switch]$multichoice, #if critical - will exit instead of returning false [Parameter(mandatory=$false,position=6)] [switch]$isCritical ) Function add-Nodes { param( [Parameter(Mandatory=$true,position=0)] $node, [Parameter(Mandatory=$false,position=1)] [int]$localDepth=0, [Parameter(Mandatory=$false,position=2)] [ValidateSet('computer','group','user','organizationalUnit')] [string[]]$filterObject ) write-verbose ("(adding node) {0} | type: {1} | deph: {2}" -f $node.text, $node.tag.type, $localDepth) if($node.tag.type -notmatch 'organizationalUnit|container|root') { return } if([string]::IsNullOrEmpty($filterObject)) { $Filter = "*" } elseif($filterObject -eq 'organizationalUnit') { $Filter="objectClass -eq 'organizationalUnit' -or objectClass -eq 'container'" } else { $Filter="objectClass -eq '$filterObject' -or objectClass -eq 'organizationalUnit' -or objectClass -eq 'container'" } if($node.tag.unfolded -eq $false ) { try { $OUobjects = get-ADObject -Filter $Filter -SearchBase $node.tag.distinguishedName -SearchScope OneLevel|Sort-Object @{E={$_.ObjectClass};Ascending=$false},name } catch { write-log "error getting objects using provided values. $($_.exception)" -type error break } $node.tag.unfolded = $true foreach($obj in $OUobjects) { if([string]::isNullOrEmpty($obj.name)) { continue } try { $NodeSub = $Node.Nodes.Add($obj.Name) } CATCH { write-host 'err' -ForegroundColor red $obj } $NodeSub.tag = [psobject]@{ distinguishedName = $obj.DistinguishedName unfolded = $false name = $rxADObjName.Match($obj.DistinguishedName).groups[1].value type = $obj.objectClass } switch($Obj.objectClass) { 'computer' { $NodeSub.ImageIndex = $nodeSub.SelectedImageIndex = 2 } 'group' { $NodeSub.ImageIndex = $nodeSub.SelectedImageIndex = 3 } 'user' { $NodeSub.ImageIndex = $nodeSub.SelectedImageIndex = 4 } 'contact' { $NodeSub.ImageIndex = $nodeSub.SelectedImageIndex = 5 } {($_ -eq 'organizationalUnit') -or ($_ -eq 'container')} { $NodeSub.ImageIndex = 0 $nodeSub.SelectedImageIndex = 1 } default { #write-log "unknown AD object type: $($obj.objectClass)" $NodeSub.ImageIndex = $nodeSub.SelectedImageIndex = 6 } } $script:NodeList += $NodeSub.tag if($localDepth -gt 0) { $addNodes=@{ node = $NodeSub localDepth = $localDepth - 1 } if($filterObject) { $addNodes.add('filterObject',$filterObject) } add-Nodes @addNodes } } } else { foreach($SubNode in $node.Nodes) { if($localDepth -gt 0) { $addNodes=@{ node = $SubNode localDepth = $localDepth -1 } if($filterObject) { $addNodes.add('filterObject',$filterObject) } add-Nodes @addNodes } } } } Function list-Nodes { param( #reference to an object [parameter(mandatory=$true,position=0)] $nodeSet, #flat - for searchlist and treeview for regular treeview object [parameter(mandatory=$false,position=1)] [validateSet('flat','treeView')] $type='treeView' ) write-verbose ("(list nodes) {0} : {1}" -f $nodeSet.checked,$nodeSet.Tag.distinguishedName) if($type -eq 'treeView') { foreach($node in $nodeSet.nodes) { list-Nodes $node } if($nodeSet.checked) { if([string]::isNullOrEmpty($filterObject) -or ($filterObject -eq $nodeSet.tag.type) ) { $nodeSet.tag.distinguishedName } } } else { foreach($node in $nodeSet.nodes) { if($node.checked) { if([string]::isNullOrEmpty($filterObject) -or ($filterObject -eq $node.tag.type) ) { $node.text } } } } } Function check-Nodes { param( [parameter(Mandatory=$true,Position=0)] $nodeSet, [parameter(Mandatory=$true,Position=1)] [bool]$set ) foreach($node in $nodeSet.Nodes) { $node.checked = $set check-Nodes -nodeSet $node -set $set } } [regex]$rxADObjName="^(?:OU|CN)=(.*?)," $script:NodeList=@() #region FORM Add-Type -AssemblyName System.Drawing Add-Type -AssemblyName System.Windows.Forms [System.Windows.Forms.Application]::EnableVisualStyles() $form = New-Object System.Windows.Forms.Form $Form.Text = "Select AD object under $startingOU" $form.MinimumSize = New-Object System.Drawing.Size(300,500) $Form.AutoSize = $true $Form.StartPosition = 'CenterScreen' $Form.Icon = [System.Drawing.SystemIcons]::Question $Form.Topmost = $true $Form.MaximizeBox = $false $form.dock = "fill" $treeView = New-Object System.Windows.Forms.TreeView $treeView.Dock = 'Fill' if($multichoice.IsPresent) { $treeView.CheckBoxes = $true } else { $treeView.CheckBoxes = $false } $treeView.Name = 'treeView' $treeViewImageList = new-object System.Windows.Forms.ImageList $treeViewImageList.Images.Add( (get-Icon -iconNumber 4 -fileContaining 'imageres.dll') ) #0 folder $treeViewImageList.Images.Add( (get-Icon -iconNumber 6 -fileContaining 'imageres.dll') ) #1 opened folder $treeViewImageList.Images.Add( (get-Icon -iconNumber 104 -fileContaining 'imageres.dll') ) #2 computer $treeViewImageList.Images.Add( (get-Icon -iconNumber 74 -fileContaining 'imageres.dll') ) #3 group $treeViewImageList.Images.Add( (get-Icon -iconNumber 208 -fileContaining 'imageres.dll') ) #4 user $treeViewImageList.Images.Add( (get-Icon -iconNumber 124 -fileContaining 'imageres.dll') ) #5 contact $treeViewImageList.Images.Add( (get-Icon -iconNumber 63 -fileContaining 'imageres.dll') ) #6 other $treeView.ImageList = $treeViewImageList $treeView.ImageIndex = 0 $treeView.SelectedImageIndex = 1 $rootNode = $treeView.Nodes.Add($startingOU) $rootNode.Tag=[psobject]@{ distinguishedName = $startingOU unfolded = $false type = "root" } $SearchTreeView = New-Object System.Windows.Forms.TreeView $SearchTreeView.Dock = 'Fill' if($multichoice.IsPresent) { $SearchTreeView.CheckBoxes = $true } else { $SearchTreeView.CheckBoxes = $false } $SearchTreeView.name = 'SearchTreeView' $okButton = New-Object System.Windows.Forms.Button $okButton.Size = New-Object System.Drawing.Size(75,23) $okButton.Anchor = 'left' $okButton.Text = "OK" $okButton.Enabled = $false $okButton.DialogResult = [System.Windows.Forms.DialogResult]::OK $Form.AcceptButton = $okButton $cancelButton = New-Object System.Windows.Forms.Button $cancelButton.Size = New-Object System.Drawing.Size(75,23) $cancelButton.anchor = 'right' $cancelButton.Text = "Cancel" $cancelButton.DialogResult = [System.Windows.Forms.DialogResult]::Cancel $Form.CancelButton = $cancelButton $txtSearch = New-Object system.Windows.Forms.TextBox $txtSearch.multiline = $false $txtSearch.ReadOnly = $false $txtSearch.MinimumSize = new-object System.Drawing.Size(300,20) $txtSearch.Height = 20 $txtSearch.Font = New-Object System.Drawing.Font('Microsoft Sans Serif', 8) $txtSearch.Location = new-object System.Drawing.Point(3,3) $mainTable = New-Object System.Windows.Forms.TableLayoutPanel $mainTable.AutoSize = $true $mainTable.ColumnCount = 2 $mainTable.RowCount = 3 $mainTable.Dock = "fill" $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Absolute,30)) )|out-null $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Percent,100)) )|out-null $mainTable.RowStyles.Add( (new-object System.Windows.Forms.RowStyle([System.Windows.Forms.SizeType]::Absolute,30)) )|out-null $mainTable.controls.Add($txtSearch,0,0) $mainTable.SetColumnSpan($txtSearch,2) $mainTable.Controls.Add($treeView,1,0) $mainTable.SetColumnSpan($treeView,2) $mainTable.Controls.add($okButton,2,0) $mainTable.Controls.add($cancelButton,2,1) $form.Controls.Add($mainTable) #endregion FORM #region FORM_FUNCTIONS $txtSearch.add_KeyUp({ #param($sender,$e) if($txtSearch.Text.Length -gt 1 -and ($mainTable.Controls|Where-Object name -eq 'treeView')) { $mainTable.Controls.Remove($treeView) $mainTable.controls.add($searchTreeView,1,0) $mainTable.SetColumnSpan($searchTreeView,2) $form.Refresh() } if($txtSearch.Text.Length -le 1) { $mainTable.Controls.Remove($searchTreeView) $mainTable.Controls.Add($treeView,1,0) $form.Refresh() } if($txtSearch.Text.Length -gt 1) { $searchTreeView.Nodes.Clear() foreach($n in $NodeList) { if($n.name -match $txtSearch.Text) { $searchTreeView.Nodes.Add($n.distinguishedName) } } } }) $txtSearch.add_gotFocus({ $okButton.Enabled = $false }) $SearchTreeView.add_afterSelect({ $okButton.Enabled = $true }) $SearchTreeView.add_afterCheck({ $okButton.Enabled = $true }) $treeview.add_afterSelect({ param($sender,$e) [System.Windows.Forms.Cursor]::Current = 'WaitCursor' [System.Windows.Forms.Application]::UseWaitCursor=$true if(!$script:COLLAPSING) { $okButton.Enabled = $true $e.node.Expand() $addNodes=@{ node = $treeView.SelectedNode localDepth = 1 } if($filterObject) { $addNodes.add('filterObject',$filterObject) } add-Nodes @addNodes if($treeView.SelectedNode.text -eq $startingOU -and $disableRoot) { $okButton.Enabled = $false } else { $okButton.Enabled = $true } } else { $script:COLLAPSING = $false } [System.Windows.Forms.Application]::UseWaitCursor=$false }) $treeView.add_BeforeCollapse({ $script:COLLAPSING = $true }) $treeview.add_beforeExpand({ param($sender, $e) $treeView.SelectedNode = $e.node }) $treeView.add_afterCheck({ param($sender, $e) [System.Windows.Forms.Cursor]::Current = 'WaitCursor' [System.Windows.Forms.Application]::UseWaitCursor=$true $addNodes=@{ node = $e.node localDepth = 1000 } if($filterObject) { $addNodes.add('filterObject',$filterObject) } add-Nodes @addNodes check-Nodes -nodeSet $e.node -set $e.node.checked [System.Windows.Forms.Application]::UseWaitCursor=$false [System.Windows.Forms.Cursor]::Current = 'Default' }) #endregion FORM_FUNCTIONS #region SCRIPT_BODY $COLLAPSING = $false $DEPTH = 1 if($loadAll) { $DEPTH = 1000 write-log "LOADING FULL TREE..." -type warning } else { write-log "loading..." -type info } $addNodes=@{ node = $rootNode localDepth = $DEPTH } if($filterObject) { $addNodes.add('filterObject',$filterObject) } #[System.Windows.Forms.Application]::UseWaitCursor=$true $form.UseWaitCursor=$true add-Nodes @addNodes $treeView.nodes[0].Expand() #[System.Windows.Forms.Application]::UseWaitCursor=$false $form.UseWaitCursor=$false $result = $Form.ShowDialog() #endregion SCRIPT_BODY #region results if ($result -eq [System.Windows.Forms.DialogResult]::OK) { $currentView=($mainTable.controls|? name -match 'treeView') if($currentView.name -eq 'treeView') { #return from regular treeview if($object.IsPresent) { #return as object if($multichoice.IsPresent) { return (list-Nodes $currentView|%{Get-ADObject $_ -properties *}) } else { return (Get-ADObject $currentView.SelectedNode.tag.distinguishedName -properties *) } } else { #return as string - default if($multichoice.IsPresent) { return (list-Nodes $currentView) } else { return $currentView.SelectedNode.tag.distinguishedName } } } else { #return from 'search' space - which is not a treeview anymore if($object.IsPresent) { if($multichoice.IsPresent) { return (list-Nodes $currentView -type flat|%{Get-ADObject $_ -properties *}) } else { return (Get-ADObject $currentView.SelectedNode.text -properties *) } } else { if($multichoice.IsPresent) { return (list-Nodes $currentView -type flat) } else { return $currentView.SelectedNode.text } } } } if($isCritical.IsPresent) { write-log "cancelled." break } return $false } function select-OrganizationalUnit { <# .SYNOPSIS proxy function for backward compatibility - replaced by select-ADObject .LINK https://w-files.pl .NOTES nExoR ::))o- version 210810 last changes - 210810 initialized #TO|DO #> param( #starting OU (tree root) [Parameter(mandatory=$false,position=0)] [string]$startingOU=(get-ADRootDSE).defaultNamingContext, #root node can't be selected [Parameter(mandatory=$false,position=1)] [switch]$disableRoot, #return OU object instead of string name [Parameter(mandatory=$false,position=2)] [switch]$object, #enable text search box - will load entire tree which might take time, but will allow to search thru entire tree [Parameter(mandatory=$false,position=3)] [switch]$loadAll, #if critical - will exit instead of returning false [Parameter(mandatory=$false,position=4)] [switch]$isCritical ) $runParam = @{ startingOU = $startingOU filterObject = 'organizationalUnit' } if($disableRoot) { $runParam.Add('disableRoot',$true) } if($object) { $runParam.Add('object',$true) } if($loadAll) { $runParam.Add('loadAll',$true) } if($isCritical) { $runParam.Add('isCritical',$true) } select-ADObject @runParam } set-alias -Name select-OU -Value select-OrganizationalUnit #################################################### connection checkers function get-ExchangeConnectionStatus { <# .SYNOPSIS check Ex/EXO connection status. .DESCRIPTION Exchange is using Remoting commands. this function verifies if session connection exists. .EXAMPLE get-ExchangeConnectionStatus -isCritical checks connection and exits if not present. .EXAMPLE if(-not get-ExchangeConnectionStatus) { write-log "you should connect to Exchange first, scrpt will run with limited options" } checks connection and warns about lack of Exchange connectivity. .INPUTS None. .OUTPUTS None. .LINK https://w-files.pl .NOTES nExoR ::))o- version 210302 last changes - 210302 validation domain added - 210208 initialized #TO|DO - isCritical flag - verify domain name #> param( #define if connection to EXO or Ex Onprem [parameter(mandatory=$false,position=0)] [validateSet('OnPrem','EXO')] [string]$ExType='EXO', #if connection is not established exit with error instead of returning $false. [parameter(mandatory=$false,position=1)] [switch]$isCritical, #you can enforce check against particular tenant so script does not run in improper tenant [parameter(mandatory=$false,position=2)] [string]$validateDomainName ) $exConnection=$false foreach($session in $(get-PSSession)) { if($session.ConfigurationName -eq 'Microsoft.Exchange') { if($ExType -eq 'EXO' -and $session.ComputerName -eq 'outlook.office365.com') { $exConnection=$true } if($ExType -eq 'OnPrem' -and $session.ComputerName -ne 'outlook.office365.com') { $exConnection=$true } } } if($isCritical.IsPresent -and !$exConnection) { write-log "connection to $ExType not established. quitting." -type error exit } if($validateDomainName) { $connectionDomainName = (Get-AcceptedDomain | Where-Object default).Name if($connectionDomainName -ne $validateDomainName) { write-log "conection established to $connectionDomainName but session expected to $validateDomainName. " -type error if($isCritical.IsPresent) { exit } else { $exConnection = $false } } } return $exConnection } function get-AzureADConnectionStatus { param( #defines if connection is critical (will exit). by default script will return $null or defalt azure domain name. [parameter(mandatory=$false,position=0)] [switch]$isCritical ) $testAAD=$null try { $testAAD=( Get-AzureADDomain |Where-Object isDefault ).name } catch { if($isCritical) { write-Log "connection to AAD not established. please use connect-AzureAD first. quitting" -type error exit } else { write-Log "connection to AAD not established." -type warning } } return $testAAD } function connect-Azure { <# .SYNOPSIS quick Azure connection check by verifying AzContext. .DESCRIPTION there is no session to Azure and Az commandlets are using saved AzContext and token. when token expires, context is returned, but connection attemt will return error. to clean it up - best is to clear context and exforce re-authentication. function is checking azcontext and test connection by calling get-AzTenant. clears context if connection is broken. .EXAMPLE connect-Azure checks AzContext and connection health .INPUTS None. .OUTPUTS None. .LINK https://w-files.pl .NOTES nExoR ::))o- version 210302 last changes - 210302 fix to expired token - PSMessageDetail is not populated on many OSes. why? - 210301 proper detection of expired tokens - 210220 proper handiling of consonle call - return instead of exit - 210219 extended handling of context expiration - 210208 initialized #TO|DO #> try { $AzSourceContext=Get-AzContext } catch { write-log $_.exception -type error write-log "trying to fix" -type info Clear-AzContext -Force } if([string]::IsNullOrEmpty( $AzSourceContext ) ) { write-log "you need to be connected before running this script. use connect-AzAccount first." -type warning $AzSourceContext = Connect-AzAccount -ErrorAction SilentlyContinue if([string]::isNullOrEmpty($AzSourceContext) ) { if( (Get-PSCallStack).count -gt 2 ) { #run from script write-log "cancelled" exit } else { #run from console write-log "cancelled" return $null } } $AzSourceContext = Get-AzContext } else { #token exist, check if it is still working try{ #if access token has been revoked, Az commands return warning "Unable to acquire token for tenant" Get-AzSubscription -WarningAction stop|Out-Null } catch { if($_.Exception -match 'Unable to acquire token for tenant') { write-log "token expired, clearing cache" -type info Clear-AzContext -Force write-log "re-run the script." if( (Get-PSCallStack).count -gt 2 ) { #run from script exit } else { #run from console return $null } } else { write-log $_.exception return -3 } } } write-log "connected to $($AzSourceContext.Subscription.name) as $($AzSourceContext.account.id)" -silent -type info write-host "Your Azure connection:" write-host " subscription: " -noNewLine write-host -foreground Yellow "$($AzSourceContext.Subscription.name)" write-host " connected as: " -noNewLine write-host -foreground Yellow "$($AzSourceContext.account.id)" Set-Item Env:\SuppressAzurePowerShellBreakingChangeWarnings "true" } Export-ModuleMember -Function * -Alias 'load-CSV','select-OU','convert-XLS2CSV','convert-CSV2XLS' |