File size: 62,341 Bytes
8c763fb | 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Management.Automation;
using System.Text;
#pragma warning disable 1634, 1691 // Stops compiler from warning about unknown warnings
namespace Microsoft.PowerShell.Commands
{
#region BaseCsvWritingCommand
/// <summary>
/// This class implements the base for exportcsv and converttocsv commands.
/// </summary>
public abstract class BaseCsvWritingCommand : PSCmdlet
{
#region Command Line Parameters
/// <summary>
/// Property that sets delimiter.
/// </summary>
[Parameter(Position = 1, ParameterSetName = "Delimiter")]
[ValidateNotNull]
public char Delimiter { get; set; }
/// <summary>
/// Culture switch for csv conversion
/// </summary>
[Parameter(ParameterSetName = "UseCulture")]
public SwitchParameter UseCulture { get; set; }
/// <summary>
/// Abstract Property - Input Object which is written in Csv format.
/// Derived as Different Attributes.In ConvertTo-CSV, This is a positional parameter. Export-CSV not a Positional behaviour.
/// </summary>
public abstract PSObject InputObject { get; set; }
/// <summary>
/// IncludeTypeInformation : The #TYPE line should be generated. Default is false.
/// </summary>
[Parameter]
[Alias("ITI")]
public SwitchParameter IncludeTypeInformation { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to suppress the #TYPE line.
/// This parameter is obsolete and has no effect. It is retained for backward compatibility only.
/// </summary>
[Parameter(DontShow = true)]
[Alias("NTI")]
[Obsolete("This parameter is obsolete and has no effect. The default behavior is to not include type information. Use -IncludeTypeInformation to include type information.")]
public SwitchParameter NoTypeInformation { get; set; } = true;
/// <summary>
/// Gets or sets list of fields to quote in output.
/// </summary>
[Parameter]
[Alias("QF")]
public string[] QuoteFields { get; set; }
/// <summary>
/// Gets or sets option to use or suppress quotes in output.
/// </summary>
[Parameter]
[Alias("UQ")]
public QuoteKind UseQuotes { get; set; } = QuoteKind.Always;
/// <summary>
/// Gets or sets property that writes csv file with no headers.
/// </summary>
[Parameter]
public SwitchParameter NoHeader { get; set; }
#endregion Command Line Parameters
/// <summary>
/// Kind of output quoting.
/// </summary>
public enum QuoteKind
{
/// <summary>
/// Never quote output.
/// </summary>
Never,
/// <summary>
/// Always quote output.
/// </summary>
Always,
/// <summary>
/// Quote output as needed (a field contains used delimiter).
/// </summary>
AsNeeded
}
/// <summary>
/// Write the string to a file or pipeline.
/// </summary>
public virtual void WriteCsvLine(string line)
{
}
/// <summary>
/// BeginProcessing override.
/// </summary>
protected override void BeginProcessing()
{
if (this.MyInvocation.BoundParameters.ContainsKey(nameof(QuoteFields)) && this.MyInvocation.BoundParameters.ContainsKey(nameof(UseQuotes)))
{
InvalidOperationException exception = new(CsvCommandStrings.CannotSpecifyQuoteFieldsAndUseQuotes);
ErrorRecord errorRecord = new(exception, "CannotSpecifyQuoteFieldsAndUseQuotes", ErrorCategory.InvalidData, null);
this.ThrowTerminatingError(errorRecord);
}
Delimiter = ImportExportCSVHelper.SetDelimiter(this, ParameterSetName, Delimiter, UseCulture);
}
}
#endregion
#region Export-CSV Command
/// <summary>
/// Implementation for the Export-Csv command.
/// </summary>
[Cmdlet(VerbsData.Export, "Csv", SupportsShouldProcess = true, DefaultParameterSetName = "Delimiter", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096608")]
public sealed class ExportCsvCommand : BaseCsvWritingCommand, IDisposable
{
#region Command Line Parameters
// If a Passthru parameter is added, the ShouldProcess
// implementation will need to be changed.
/// <summary>
/// Input Object for CSV Writing.
/// </summary>
[Parameter(ValueFromPipeline = true, Mandatory = true, ValueFromPipelineByPropertyName = true)]
public override PSObject InputObject { get; set; }
/// <summary>
/// Mandatory file name to write to.
/// </summary>
[Parameter(Position = 0)]
[ValidateNotNullOrEmpty]
public string Path
{
get
{
return _path;
}
set
{
_path = value;
_specifiedPath = true;
}
}
private string _path;
private bool _specifiedPath = false;
/// <summary>
/// The literal path of the mandatory file name to write to.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[Alias("PSPath", "LP")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string LiteralPath
{
get
{
return _path;
}
set
{
_path = value;
_isLiteralPath = true;
}
}
private bool _isLiteralPath = false;
/// <summary>
/// Gets or sets property that sets force parameter.
/// </summary>
[Parameter]
public SwitchParameter Force { get; set; }
/// <summary>
/// Gets or sets property that prevents file overwrite.
/// </summary>
[Parameter]
[Alias("NoOverwrite")]
public SwitchParameter NoClobber { get; set; }
/// <summary>
/// Gets or sets encoding optional flag.
/// </summary>
[Parameter]
[ArgumentToEncodingTransformation]
[ArgumentEncodingCompletions]
[ValidateNotNullOrEmpty]
public Encoding Encoding
{
get
{
return _encoding;
}
set
{
EncodingConversion.WarnIfObsolete(this, value);
_encoding = value;
}
}
private Encoding _encoding = Encoding.Default;
/// <summary>
/// Gets or sets property that sets append parameter.
/// </summary>
[Parameter]
public SwitchParameter Append { get; set; }
// true if Append=true AND the file written was not empty (or nonexistent) when the cmdlet was invoked
private bool _isActuallyAppending;
#endregion
#region Overrides
private bool _shouldProcess;
private IList<string> _propertyNames;
private IList<string> _preexistingPropertyNames;
private ExportCsvHelper _helper;
/// <summary>
/// BeginProcessing override.
/// </summary>
protected override void BeginProcessing()
{
base.BeginProcessing();
// Validate that they don't provide both Path and LiteralPath, but have provided at least one.
if (!(_specifiedPath ^ _isLiteralPath))
{
InvalidOperationException exception = new(CsvCommandStrings.CannotSpecifyPathAndLiteralPath);
ErrorRecord errorRecord = new(exception, "CannotSpecifyPathAndLiteralPath", ErrorCategory.InvalidData, null);
this.ThrowTerminatingError(errorRecord);
}
// Validate that Append and NoHeader are not specified together.
if (Append && NoHeader)
{
InvalidOperationException exception = new(CsvCommandStrings.CannotSpecifyAppendAndNoHeader);
ErrorRecord errorRecord = new(exception, "CannotSpecifyBothAppendAndNoHeader", ErrorCategory.InvalidData, null);
this.ThrowTerminatingError(errorRecord);
}
_shouldProcess = ShouldProcess(Path);
if (!_shouldProcess)
{
return;
}
CreateFileStream();
_helper = new ExportCsvHelper(base.Delimiter, base.UseQuotes, base.QuoteFields);
}
/// <summary>
/// Convert the current input object to Csv and write to file/WriteObject.
/// </summary>
protected override void ProcessRecord()
{
if (InputObject == null || _sw == null)
{
return;
}
if (!_shouldProcess)
{
return;
}
// Process first object
if (_propertyNames == null)
{
// figure out the column names (and lock-in their order)
_propertyNames = ExportCsvHelper.BuildPropertyNames(InputObject, _propertyNames);
if (_isActuallyAppending && _preexistingPropertyNames != null)
{
this.ReconcilePreexistingPropertyNames();
}
// write headers (row1: typename + row2: column names)
if (!_isActuallyAppending && !NoHeader.IsPresent)
{
if (IncludeTypeInformation)
{
WriteCsvLine(ExportCsvHelper.GetTypeString(InputObject));
}
WriteCsvLine(_helper.ConvertPropertyNamesCSV(_propertyNames));
}
}
string csv = _helper.ConvertPSObjectToCSV(InputObject, _propertyNames);
WriteCsvLine(csv);
}
/// <summary>
/// EndProcessing.
/// </summary>
protected override void EndProcessing()
{
CleanUp();
}
#endregion Overrides
#region file
/// <summary>
/// Handle to file stream.
/// </summary>
private FileStream _fs;
/// <summary>
/// Stream writer used to write to file.
/// </summary>
private StreamWriter _sw = null;
/// <summary>
/// Handle to file whose read-only attribute should be reset when we are done.
/// </summary>
private FileInfo _readOnlyFileInfo = null;
private void CreateFileStream()
{
if (_path == null)
{
throw new InvalidOperationException(CsvCommandStrings.FileNameIsAMandatoryParameter);
}
string resolvedFilePath = PathUtils.ResolveFilePath(this.Path, this, _isLiteralPath);
bool isCsvFileEmpty = true;
if (this.Append && File.Exists(resolvedFilePath))
{
using (StreamReader streamReader = PathUtils.OpenStreamReader(this, this.Path, Encoding, _isLiteralPath))
{
isCsvFileEmpty = streamReader.Peek() == -1;
}
}
// If the csv file is empty then even append is treated as regular export (i.e., both header & values are added to the CSV file).
_isActuallyAppending = this.Append && File.Exists(resolvedFilePath) && !isCsvFileEmpty;
if (_isActuallyAppending)
{
Encoding encodingObject;
using (StreamReader streamReader = PathUtils.OpenStreamReader(this, this.Path, Encoding, _isLiteralPath))
{
ImportCsvHelper readingHelper = new(
this, this.Delimiter, null /* header */, null /* typeName */, streamReader);
readingHelper.ReadHeader();
_preexistingPropertyNames = readingHelper.Header;
encodingObject = streamReader.CurrentEncoding;
}
PathUtils.MasterStreamOpen(
this,
this.Path,
encodingObject,
defaultEncoding: false,
Append,
Force,
NoClobber,
out _fs,
out _sw,
out _readOnlyFileInfo,
_isLiteralPath);
}
else
{
PathUtils.MasterStreamOpen(
this,
this.Path,
Encoding,
defaultEncoding: false,
Append,
Force,
NoClobber,
out _fs,
out _sw,
out _readOnlyFileInfo,
_isLiteralPath);
}
}
private void CleanUp()
{
if (_fs != null)
{
if (_sw != null)
{
_sw.Dispose();
_sw = null;
}
_fs.Dispose();
_fs = null;
// reset the read-only attribute
if (_readOnlyFileInfo != null)
_readOnlyFileInfo.Attributes |= FileAttributes.ReadOnly;
}
_helper?.Dispose();
}
private void ReconcilePreexistingPropertyNames()
{
if (!_isActuallyAppending)
{
throw new InvalidOperationException(CsvCommandStrings.ReconcilePreexistingPropertyNamesMethodShouldOnlyGetCalledWhenAppending);
}
if (_preexistingPropertyNames == null)
{
throw new InvalidOperationException(CsvCommandStrings.ReconcilePreexistingPropertyNamesMethodShouldOnlyGetCalledWhenPreexistingPropertyNamesHaveBeenReadSuccessfully);
}
HashSet<string> appendedPropertyNames = new(StringComparer.OrdinalIgnoreCase);
foreach (string appendedPropertyName in _propertyNames)
{
appendedPropertyNames.Add(appendedPropertyName);
}
foreach (string preexistingPropertyName in _preexistingPropertyNames)
{
if (!appendedPropertyNames.Contains(preexistingPropertyName))
{
if (!Force)
{
string errorMessage = string.Format(
CultureInfo.InvariantCulture, // property names and file names are culture invariant
CsvCommandStrings.CannotAppendCsvWithMismatchedPropertyNames,
preexistingPropertyName,
this.Path);
InvalidOperationException exception = new(errorMessage);
ErrorRecord errorRecord = new(exception, "CannotAppendCsvWithMismatchedPropertyNames", ErrorCategory.InvalidData, preexistingPropertyName);
this.ThrowTerminatingError(errorRecord);
}
}
}
_propertyNames = _preexistingPropertyNames;
_preexistingPropertyNames = null;
}
/// <summary>
/// Write the csv line to file.
/// </summary>
/// <param name="line">Line to write.</param>
public override void WriteCsvLine(string line)
{
// NTRAID#Windows Out Of Band Releases-915851-2005/09/13
if (_disposed)
{
throw PSTraceSource.NewObjectDisposedException("ExportCsvCommand");
}
_sw.WriteLine(line);
}
#endregion file
#region IDisposable Members
/// <summary>
/// Set to true when object is disposed.
/// </summary>
private bool _disposed;
/// <summary>
/// Public dispose method.
/// </summary>
public void Dispose()
{
if (!_disposed)
{
CleanUp();
}
_disposed = true;
}
#endregion IDisposable Members
}
#endregion Export-CSV Command
#region Import-CSV Command
/// <summary>
/// Implements Import-Csv command.
/// </summary>
[Cmdlet(VerbsData.Import, "Csv", DefaultParameterSetName = "DelimiterPath", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097020")]
public sealed class ImportCsvCommand : PSCmdlet
{
#region Command Line Parameters
/// <summary>
/// Gets or sets property that sets delimiter.
/// </summary>
[Parameter(Position = 1, ParameterSetName = "DelimiterPath")]
[Parameter(Position = 1, ParameterSetName = "DelimiterLiteralPath")]
[ValidateNotNull]
public char Delimiter { get; set; }
/// <summary>
/// Gets or sets mandatory file name to read from.
/// </summary>
[Parameter(Position = 0, ParameterSetName = "DelimiterPath", Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
[Parameter(Position = 0, ParameterSetName = "CulturePath", Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
[ValidateNotNullOrEmpty]
public string[] Path
{
get
{
return _paths;
}
set
{
_paths = value;
_specifiedPath = true;
}
}
private string[] _paths;
private bool _specifiedPath = false;
/// <summary>
/// Gets or sets the literal path of the mandatory file name to read from.
/// </summary>
[Parameter(ParameterSetName = "DelimiterLiteralPath", Mandatory = true, ValueFromPipelineByPropertyName = true)]
[Parameter(ParameterSetName = "CultureLiteralPath", Mandatory = true, ValueFromPipelineByPropertyName = true)]
[ValidateNotNullOrEmpty]
[Alias("PSPath", "LP")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] LiteralPath
{
get
{
return _paths;
}
set
{
_paths = value;
_isLiteralPath = true;
}
}
private bool _isLiteralPath = false;
/// <summary>
/// Gets or sets property that sets UseCulture parameter.
/// </summary>
[Parameter(ParameterSetName = "CulturePath", Mandatory = true)]
[Parameter(ParameterSetName = "CultureLiteralPath", Mandatory = true)]
[ValidateNotNull]
public SwitchParameter UseCulture { get; set; }
/// <summary>
/// Gets or sets header property to customize the names.
/// </summary>
[Parameter(Mandatory = false)]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Header { get; set; }
/// <summary>
/// Gets or sets encoding optional flag.
/// </summary>
[Parameter]
[ArgumentToEncodingTransformation]
[ArgumentEncodingCompletions]
[ValidateNotNullOrEmpty]
public Encoding Encoding
{
get
{
return _encoding;
}
set
{
EncodingConversion.WarnIfObsolete(this, value);
_encoding = value;
}
}
private Encoding _encoding = Encoding.Default;
/// <summary>
/// Avoid writing out duplicate warning messages when there are one or more unspecified names.
/// </summary>
private bool _alreadyWarnedUnspecifiedNames = false;
#endregion Command Line Parameters
#region Override Methods
/// <summary>
/// BeginProcessing override.
/// </summary>
protected override void BeginProcessing()
{
Delimiter = ImportExportCSVHelper.SetDelimiter(this, ParameterSetName, Delimiter, UseCulture);
}
/// <summary>
/// ProcessRecord overload.
/// </summary>
protected override void ProcessRecord()
{
// Validate that they don't provide both Path and LiteralPath, but have provided at least one.
if (!(_specifiedPath ^ _isLiteralPath))
{
InvalidOperationException exception = new(CsvCommandStrings.CannotSpecifyPathAndLiteralPath);
ErrorRecord errorRecord = new(exception, "CannotSpecifyPathAndLiteralPath", ErrorCategory.InvalidData, null);
this.ThrowTerminatingError(errorRecord);
}
if (_paths != null)
{
foreach (string path in _paths)
{
using (StreamReader streamReader = PathUtils.OpenStreamReader(this, path, this.Encoding, _isLiteralPath))
{
ImportCsvHelper helper = new(this, Delimiter, Header, null /* typeName */, streamReader);
try
{
helper.Import(ref _alreadyWarnedUnspecifiedNames);
}
catch (ExtendedTypeSystemException exception)
{
ErrorRecord errorRecord = new(exception, "AlreadyPresentPSMemberInfoInternalCollectionAdd", ErrorCategory.NotSpecified, null);
this.ThrowTerminatingError(errorRecord);
}
}
}
}
}
}
#endregion Override Methods
#endregion Import-CSV Command
#region ConvertTo-CSV Command
/// <summary>
/// Implements ConvertTo-Csv command.
/// </summary>
[Cmdlet(VerbsData.ConvertTo, "Csv", DefaultParameterSetName = "Delimiter",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096832", RemotingCapability = RemotingCapability.None)]
[OutputType(typeof(string))]
public sealed class ConvertToCsvCommand : BaseCsvWritingCommand
{
#region Parameter
/// <summary>
/// Overrides Base InputObject.
/// </summary>
[Parameter(ValueFromPipeline = true, Mandatory = true, ValueFromPipelineByPropertyName = true, Position = 0)]
public override PSObject InputObject { get; set; }
#endregion Parameter
#region Overrides
/// <summary>
/// Stores Property Names.
/// </summary>
private IList<string> _propertyNames;
/// <summary>
/// </summary>
private ExportCsvHelper _helper;
/// <summary>
/// BeginProcessing override.
/// </summary>
protected override void BeginProcessing()
{
base.BeginProcessing();
_helper = new ExportCsvHelper(base.Delimiter, base.UseQuotes, base.QuoteFields);
}
/// <summary>
/// Convert the current input object to Csv and write to stream/WriteObject.
/// </summary>
protected override void ProcessRecord()
{
if (InputObject == null)
{
return;
}
// Process first object
if (_propertyNames == null)
{
_propertyNames = ExportCsvHelper.BuildPropertyNames(InputObject, _propertyNames);
if (!NoHeader.IsPresent)
{
if (IncludeTypeInformation)
{
WriteCsvLine(ExportCsvHelper.GetTypeString(InputObject));
}
// Write property information
string properties = _helper.ConvertPropertyNamesCSV(_propertyNames);
if (!properties.Equals(string.Empty))
{
WriteCsvLine(properties);
}
}
}
string csv = _helper.ConvertPSObjectToCSV(InputObject, _propertyNames);
// Write to the output stream
if (csv != string.Empty)
{
WriteCsvLine(csv);
}
}
#endregion Overrides
#region CSV conversion
/// <summary>
/// Write the line to output.
/// </summary>
/// <param name="line">Line to write.</param>
public override void WriteCsvLine(string line)
{
WriteObject(line);
}
#endregion CSV conversion
}
#endregion ConvertTo-CSV Command
#region ConvertFrom-CSV Command
/// <summary>
/// Implements ConvertFrom-Csv command.
/// </summary>
[Cmdlet(VerbsData.ConvertFrom, "Csv", DefaultParameterSetName = "Delimiter",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096830", RemotingCapability = RemotingCapability.None)]
public sealed class ConvertFromCsvCommand : PSCmdlet
{
#region Command Line Parameters
/// <summary>
/// Property that sets delimiter.
/// </summary>
[Parameter(Position = 1, ParameterSetName = "Delimiter")]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
public char Delimiter { get; set; }
/// <summary>
/// Culture switch for csv conversion
/// </summary>
[Parameter(ParameterSetName = "UseCulture", Mandatory = true)]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
public SwitchParameter UseCulture { get; set; }
/// <summary>
/// Gets or sets input object which is written in Csv format.
/// </summary>
[Parameter(ValueFromPipeline = true, Mandatory = true, ValueFromPipelineByPropertyName = true, Position = 0)]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public PSObject[] InputObject { get; set; }
/// <summary>
/// Gets or sets header property to customize the names.
/// </summary>
[Parameter(Mandatory = false)]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Header { get; set; }
/// <summary>
/// Avoid writing out duplicate warning messages when there are one or more unspecified names.
/// </summary>
private bool _alreadyWarnedUnspecifiedNames = false;
#endregion Command Line Parameters
#region Overrides
/// <summary>
/// BeginProcessing override.
/// </summary>
protected override void BeginProcessing()
{
Delimiter = ImportExportCSVHelper.SetDelimiter(this, ParameterSetName, Delimiter, UseCulture);
}
/// <summary>
/// Convert the current input object to Csv and write to stream/WriteObject.
/// </summary>
protected override void ProcessRecord()
{
foreach (PSObject inputObject in InputObject)
{
using (MemoryStream memoryStream = new(Encoding.Unicode.GetBytes(inputObject.ToString())))
using (StreamReader streamReader = new(memoryStream, System.Text.Encoding.Unicode))
{
ImportCsvHelper helper = new(this, Delimiter, Header, _typeName, streamReader);
try
{
helper.Import(ref _alreadyWarnedUnspecifiedNames);
}
catch (ExtendedTypeSystemException exception)
{
ErrorRecord errorRecord = new(exception, "AlreadyPresentPSMemberInfoInternalCollectionAdd", ErrorCategory.NotSpecified, null);
this.ThrowTerminatingError(errorRecord);
}
if ((Header == null) && (helper.Header != null))
{
Header = helper.Header.ToArray();
}
if ((_typeName == null) && (helper.TypeName != null))
{
_typeName = helper.TypeName;
}
}
}
}
#endregion Overrides
private string _typeName;
}
#endregion ConvertFrom-CSV Command
#region CSV conversion
#region ExportHelperConversion
/// <summary>
/// Helper class for Export-Csv and ConvertTo-Csv.
/// </summary>
internal sealed class ExportCsvHelper : IDisposable
{
private readonly char _delimiter;
private readonly BaseCsvWritingCommand.QuoteKind _quoteKind;
private readonly HashSet<string> _quoteFields;
private readonly StringBuilder _outputString;
/// <summary>
/// Initializes a new instance of the <see cref="ExportCsvHelper"/> class.
/// </summary>
/// <param name="delimiter">Delimiter char.</param>
/// <param name="quoteKind">Kind of quoting.</param>
/// <param name="quoteFields">List of fields to quote.</param>
internal ExportCsvHelper(char delimiter, BaseCsvWritingCommand.QuoteKind quoteKind, string[] quoteFields)
{
_delimiter = delimiter;
_quoteKind = quoteKind;
_quoteFields = quoteFields == null ? null : new HashSet<string>(quoteFields, StringComparer.OrdinalIgnoreCase);
_outputString = new StringBuilder(128);
}
// Name of properties to be written in CSV format
/// <summary>
/// Get the name of properties from source PSObject and add them to _propertyNames.
/// </summary>
internal static IList<string> BuildPropertyNames(PSObject source, IList<string> propertyNames)
{
if (propertyNames != null)
{
throw new InvalidOperationException(CsvCommandStrings.BuildPropertyNamesMethodShouldBeCalledOnlyOncePerCmdletInstance);
}
propertyNames = new Collection<string>();
if (source.BaseObject is IDictionary dictionary)
{
foreach (var key in dictionary.Keys)
{
propertyNames.Add(LanguagePrimitives.ConvertTo<string>(key));
}
// Add additional extended members added to the dictionary object, if any
var propertiesToSearch = new PSMemberInfoIntegratingCollection<PSPropertyInfo>(
source,
PSObject.GetPropertyCollection(PSMemberViewTypes.Extended));
foreach (var prop in propertiesToSearch)
{
propertyNames.Add(prop.Name);
}
}
else
{
// serialize only Extended and Adapted properties.
PSMemberInfoCollection<PSPropertyInfo> srcPropertiesToSearch =
new PSMemberInfoIntegratingCollection<PSPropertyInfo>(
source,
PSObject.GetPropertyCollection(PSMemberViewTypes.Extended | PSMemberViewTypes.Adapted));
foreach (PSPropertyInfo prop in srcPropertiesToSearch)
{
propertyNames.Add(prop.Name);
}
}
return propertyNames;
}
/// <summary>
/// Converts PropertyNames in to a CSV string.
/// </summary>
/// <returns>Converted string.</returns>
internal string ConvertPropertyNamesCSV(IList<string> propertyNames)
{
ArgumentNullException.ThrowIfNull(propertyNames);
_outputString.Clear();
bool first = true;
foreach (string propertyName in propertyNames)
{
if (first)
{
first = false;
}
else
{
_outputString.Append(_delimiter);
}
if (_quoteFields != null)
{
if (_quoteFields.TryGetValue(propertyName, out _))
{
AppendStringWithEscapeAlways(_outputString, propertyName);
}
else
{
_outputString.Append(propertyName);
}
}
else
{
switch (_quoteKind)
{
case BaseCsvWritingCommand.QuoteKind.Always:
AppendStringWithEscapeAlways(_outputString, propertyName);
break;
case BaseCsvWritingCommand.QuoteKind.AsNeeded:
if (propertyName.AsSpan().IndexOfAny(_delimiter, '\n', '"') != -1)
{
AppendStringWithEscapeAlways(_outputString, propertyName);
}
else
{
_outputString.Append(propertyName);
}
break;
case BaseCsvWritingCommand.QuoteKind.Never:
_outputString.Append(propertyName);
break;
}
}
}
return _outputString.ToString();
}
/// <summary>
/// Convert PSObject to CSV string.
/// </summary>
/// <param name="mshObject">PSObject to convert.</param>
/// <param name="propertyNames">Property names.</param>
/// <returns></returns>
internal string ConvertPSObjectToCSV(PSObject mshObject, IList<string> propertyNames)
{
ArgumentNullException.ThrowIfNull(propertyNames);
_outputString.Clear();
bool first = true;
foreach (string propertyName in propertyNames)
{
if (first)
{
first = false;
}
else
{
_outputString.Append(_delimiter);
}
string value = null;
if (mshObject.BaseObject is IDictionary dictionary)
{
if (dictionary.Contains(propertyName))
{
value = dictionary[propertyName]?.ToString();
}
else if (mshObject.Properties[propertyName] is PSPropertyInfo property)
{
value = GetToStringValueForProperty(property);
}
}
else if (mshObject.Properties[propertyName] is PSPropertyInfo property)
{
value = GetToStringValueForProperty(property);
}
// If value is null, assume property is not present and skip it.
if (value != null)
{
if (_quoteFields != null)
{
if (_quoteFields.TryGetValue(propertyName, out _))
{
AppendStringWithEscapeAlways(_outputString, value);
}
else
{
_outputString.Append(value);
}
}
else
{
switch (_quoteKind)
{
case BaseCsvWritingCommand.QuoteKind.Always:
AppendStringWithEscapeAlways(_outputString, value);
break;
case BaseCsvWritingCommand.QuoteKind.AsNeeded:
if (value != null && value.AsSpan().IndexOfAny(_delimiter, '\n', '"') != -1)
{
AppendStringWithEscapeAlways(_outputString, value);
}
else
{
_outputString.Append(value);
}
break;
case BaseCsvWritingCommand.QuoteKind.Never:
_outputString.Append(value);
break;
default:
Diagnostics.Assert(false, "BaseCsvWritingCommand.QuoteKind has new item.");
break;
}
}
}
}
return _outputString.ToString();
}
/// <summary>
/// Get value from property object.
/// </summary>
/// <param name="property"> Property to convert.</param>
/// <returns>ToString() value.</returns>
internal static string GetToStringValueForProperty(PSPropertyInfo property)
{
ArgumentNullException.ThrowIfNull(property);
string value = null;
try
{
object temp = property.Value;
if (temp != null)
{
value = temp.ToString();
}
}
catch (Exception)
{
// If we cannot read some value, treat it as null.
}
return value;
}
/// <summary>
/// Prepares string for writing type information.
/// </summary>
/// <param name="source">PSObject whose type to determine.</param>
/// <returns>String with type information.</returns>
internal static string GetTypeString(PSObject source)
{
string type = null;
// get type of source
Collection<string> tnh = source.TypeNames;
if (tnh == null || tnh.Count == 0)
{
type = "#TYPE";
}
else
{
if (tnh[0] == null)
{
throw new InvalidOperationException(CsvCommandStrings.TypeHierarchyShouldNotHaveNullValues);
}
string temp = tnh[0];
// If type starts with CSV: remove it. This would happen when you export
// an imported object. import-csv adds CSV. prefix to the type.
if (temp.StartsWith(ImportExportCSVHelper.CSVTypePrefix, StringComparison.OrdinalIgnoreCase))
{
temp = temp.Substring(4);
}
type = string.Create(System.Globalization.CultureInfo.InvariantCulture, $"#TYPE {temp}");
}
return type;
}
/// <summary>
/// Escapes the " in string if necessary.
/// Encloses the string in double quotes if necessary.
/// </summary>
internal static void AppendStringWithEscapeAlways(StringBuilder dest, string source)
{
if (source == null)
{
return;
}
// Adding Double quote to all strings
dest.Append('"');
for (int i = 0; i < source.Length; i++)
{
char c = source[i];
// Double quote in the string is escaped with double quote
if (c == '"')
{
dest.Append('"');
}
dest.Append(c);
}
dest.Append('"');
}
#region IDisposable Members
/// <summary>
/// Set to true when object is disposed.
/// </summary>
private bool _disposed;
/// <summary>
/// Public dispose method.
/// </summary>
public void Dispose()
{
if (!_disposed)
{
GC.SuppressFinalize(this);
}
_disposed = true;
}
#endregion IDisposable Members
}
#endregion ExportHelperConversion
#region ImportHelperConversion
/// <summary>
/// Helper class to import single CSV file.
/// </summary>
internal sealed class ImportCsvHelper
{
#region constructor
/// <summary>
/// Reference to cmdlet which is using this helper class.
/// </summary>
private readonly PSCmdlet _cmdlet;
/// <summary>
/// CSV delimiter (default is the "comma" / "," character).
/// </summary>
private readonly char _delimiter;
/// <summary>
/// Use "UnspecifiedName" when the name is null or empty.
/// </summary>
private const string UnspecifiedName = "H";
/// <summary>
/// Avoid writing out duplicate warning messages when there are one or more unspecified names.
/// </summary>
private bool _alreadyWarnedUnspecifiedName = false;
/// <summary>
/// Gets reference to header values.
/// </summary>
internal IList<string> Header { get; private set; }
/// <summary>
/// Gets ETS type name from the first line / comment in the CSV.
/// </summary>
internal string TypeName { get; private set; }
/// <summary>
/// Reader of the csv content.
/// </summary>
private readonly StreamReader _sr;
// Initial sizes of the value list and the line stringbuilder.
// Set to reasonable initial sizes. They may grow beyond these,
// but this will prevent a few reallocations.
private const int ValueCountGuestimate = 16;
private const int LineLengthGuestimate = 256;
internal ImportCsvHelper(PSCmdlet cmdlet, char delimiter, IList<string> header, string typeName, StreamReader streamReader)
{
ArgumentNullException.ThrowIfNull(cmdlet);
ArgumentNullException.ThrowIfNull(streamReader);
_cmdlet = cmdlet;
_delimiter = delimiter;
Header = header;
TypeName = typeName;
_sr = streamReader;
}
#endregion constructor
#region reading helpers
/// <summary>
/// This is set to true when end of file is reached.
/// </summary>
private bool EOF => _sr.EndOfStream;
private char ReadChar()
{
if (EOF)
{
throw new InvalidOperationException(CsvCommandStrings.EOFIsReached);
}
int i = _sr.Read();
return (char)i;
}
/// <summary>
/// Peeks the next character in the stream and returns true if it is same as passed in character.
/// </summary>
/// <param name="c"></param>
/// <returns></returns>
private bool PeekNextChar(char c)
{
int i = _sr.Peek();
if (i == -1)
{
return false;
}
return c == (char)i;
}
/// <summary>
/// Reads a line from file. This consumes the end of line.
/// Only use it when end of line chars are not important.
/// </summary>
/// <returns>Line from file.</returns>
private string ReadLine() => _sr.ReadLine();
#endregion reading helpers
internal void ReadHeader()
{
// Read #Type record if available
if ((TypeName == null) && (!this.EOF))
{
TypeName = ReadTypeInformation();
}
var values = new List<string>(ValueCountGuestimate);
var builder = new StringBuilder(LineLengthGuestimate);
while ((Header == null) && (!this.EOF))
{
ParseNextRecord(values, builder);
// Trim all trailing blankspaces and delimiters ( single/multiple ).
// If there is only one element in the row and if its a blankspace we dont trim it.
// A trailing delimiter is represented as a blankspace while being added to result collection
// which is getting trimmed along with blankspaces supplied through the CSV in the below loop.
while (values.Count > 1 && values[values.Count - 1].Equals(string.Empty))
{
values.RemoveAt(values.Count - 1);
}
// File starts with '#' and contains '#Fields:' is W3C Extended Log File Format
if (values.Count != 0 && values[0].StartsWith("#Fields: "))
{
values[0] = values[0].Substring(9);
Header = values;
}
else if (values.Count != 0 && values[0].StartsWith('#'))
{
// Skip all lines starting with '#'
}
else
{
// This is not W3C Extended Log File Format
// By default first line is Header
Header = values;
}
}
if (Header != null && Header.Count > 0)
{
ValidatePropertyNames(Header);
}
}
internal void Import(ref bool alreadyWriteOutWarning)
{
_alreadyWarnedUnspecifiedName = alreadyWriteOutWarning;
ReadHeader();
var prevalidated = false;
var values = new List<string>(ValueCountGuestimate);
var builder = new StringBuilder(LineLengthGuestimate);
while (true)
{
ParseNextRecord(values, builder);
if (values.Count == 0)
break;
if (values.Count == 1 && string.IsNullOrEmpty(values[0]))
{
// skip the blank lines
continue;
}
PSObject result = BuildMshobject(TypeName, Header, values, _delimiter, prevalidated);
prevalidated = true;
_cmdlet.WriteObject(result);
}
alreadyWriteOutWarning = _alreadyWarnedUnspecifiedName;
}
/// <summary>
/// Validate the names of properties.
/// </summary>
/// <param name="names"></param>
private static void ValidatePropertyNames(IList<string> names)
{
if (names != null)
{
if (names.Count == 0)
{
// If there are no names, it is an error
}
else
{
HashSet<string> headers = new(StringComparer.OrdinalIgnoreCase);
foreach (string currentHeader in names)
{
if (!string.IsNullOrEmpty(currentHeader))
{
if (!headers.Add(currentHeader))
{
// throw a terminating error as there are duplicate headers in the input.
string memberAlreadyPresentMsg =
string.Format(
CultureInfo.InvariantCulture,
ExtendedTypeSystem.MemberAlreadyPresent,
currentHeader);
ExtendedTypeSystemException exception = new(memberAlreadyPresentMsg);
throw exception;
}
}
}
}
}
}
/// <summary>
/// Read the type information, if present.
/// </summary>
/// <returns>Type string if present else null.</returns>
private string ReadTypeInformation()
{
string type = null;
if (PeekNextChar('#'))
{
string temp = ReadLine();
if (temp.StartsWith("#Type", StringComparison.OrdinalIgnoreCase))
{
type = temp.Substring(5);
type = type.Trim();
if (type.Length == 0)
{
type = null;
}
}
}
return type;
}
/// <summary>
/// Reads the next record from the file and returns parsed collection of string.
/// </summary>
/// <returns>
/// Parsed collection of strings.
/// </returns>
private void ParseNextRecord(List<string> result, StringBuilder current)
{
result.Clear();
// current string
current.Clear();
bool seenBeginQuote = false;
while (!EOF)
{
// Read the next character
char ch = ReadChar();
if (ch == _delimiter)
{
if (seenBeginQuote)
{
// Delimiter inside double quotes is part of string.
// Ex:
// "foo, bar"
// is parsed as
// ->foo, bar<-
current.Append(ch);
}
else
{
// Delimiter outside quotes is end of current word.
result.Add(current.ToString());
current.Remove(0, current.Length);
}
}
else if (ch == '"')
{
if (seenBeginQuote)
{
if (PeekNextChar('"'))
{
// "" inside double quote are single quote
// ex: "foo""bar"
// is read as
// ->foo"bar<-
// PeekNextChar only peeks. Read the next char.
ReadChar();
current.Append('"');
}
else
{
// We have seen a matching end quote.
seenBeginQuote = false;
// Read
// everything till we hit next delimiter.
// In correct CSV,1) end quote is followed by delimiter
// 2)end quote is followed some whitespaces and
// then delimiter.
// We eat the whitespaces seen after the ending quote.
// However if there are other characters, we add all of them
// to string.
// Ex: ->"foo bar"<- is read as ->foo bar<-
// ->"foo bar" <- is read as ->foo bar<-
// ->"foo bar" ab <- is read as ->"foo bar" ab <-
bool endofRecord = false;
ReadTillNextDelimiter(current, ref endofRecord, true);
result.Add(current.ToString());
current.Remove(0, current.Length);
if (endofRecord)
break;
}
}
else if (current.Length == 0)
{
// We are at the beginning of a new word.
// This quote is the first quote.
seenBeginQuote = true;
}
else
{
// We are seeing a quote after the start of
// the word. This is error, however we will be
// lenient here and do what excel does:
// Ex: foo "ba,r"
// In above example word read is ->foo "ba<-
// Basically we read till next delimiter
bool endOfRecord = false;
current.Append(ch);
ReadTillNextDelimiter(current, ref endOfRecord, false);
result.Add(current.ToString());
current.Remove(0, current.Length);
if (endOfRecord)
break;
}
}
else if (ch == ' ' || ch == '\t')
{
if (seenBeginQuote)
{
// Spaces in side quote are valid
current.Append(ch);
}
else if (current.Length == 0)
{
// ignore leading spaces
continue;
}
else
{
// We are not in quote and we are not at the
// beginning of a word. We should not be seeing
// spaces here. This is an error condition, however
// we will be lenient here and do what excel does,
// that is read till next delimiter.
// Ex: ->foo <- is read as ->foo<-
// Ex: ->foo bar<- is read as ->foo bar<-
// Ex: ->foo bar <- is read as ->foo bar <-
// Ex: ->foo bar "er,ror"<- is read as ->foo bar "er<-
bool endOfRecord = false;
current.Append(ch);
ReadTillNextDelimiter(current, ref endOfRecord, true);
result.Add(current.ToString());
current.Remove(0, current.Length);
if (endOfRecord)
{
break;
}
}
}
else if (IsNewLine(ch, out string newLine))
{
if (seenBeginQuote)
{
// newline inside quote are valid
current.Append(newLine);
}
else
{
result.Add(current.ToString());
current.Remove(0, current.Length);
// New line outside quote is end of word and end of record
break;
}
}
else
{
current.Append(ch);
}
}
if (current.Length != 0)
{
result.Add(current.ToString());
}
}
// If we detect a newline we return it as a string "\r", "\n" or "\r\n"
private bool IsNewLine(char ch, out string newLine)
{
newLine = string.Empty;
if (ch == '\r')
{
if (PeekNextChar('\n'))
{
ReadChar();
newLine = "\r\n";
}
else
{
newLine = "\r";
}
}
else if (ch == '\n')
{
newLine = "\n";
}
return newLine != string.Empty;
}
/// <summary>
/// This function reads the characters till next delimiter and adds them to current.
/// </summary>
/// <param name="current"></param>
/// <param name="endOfRecord">
/// This is true if end of record is reached
/// when delimiter is hit. This would be true if delimiter is NewLine.
/// </param>
/// <param name="eatTrailingBlanks">
/// If this is true, eat the trailing blanks. Note:if there are non
/// whitespace characters present, then trailing blanks are not consumed.
/// </param>
private void ReadTillNextDelimiter(StringBuilder current, ref bool endOfRecord, bool eatTrailingBlanks)
{
StringBuilder temp = new();
// Did we see any non-whitespace character
bool nonWhiteSpace = false;
while (true)
{
if (EOF)
{
endOfRecord = true;
break;
}
char ch = ReadChar();
if (ch == _delimiter)
{
break;
}
else if (IsNewLine(ch, out string newLine))
{
endOfRecord = true;
break;
}
else
{
temp.Append(ch);
if (ch != ' ' && ch != '\t')
{
nonWhiteSpace = true;
}
}
}
if (eatTrailingBlanks && !nonWhiteSpace)
{
string s = temp.ToString();
s = s.Trim();
current.Append(s);
}
else
{
current.Append(temp);
}
}
private PSObject BuildMshobject(string type, IList<string> names, List<string> values, char delimiter, bool preValidated = false)
{
PSObject result = new(names.Count);
char delimiterlocal = delimiter;
int unspecifiedNameIndex = 1;
for (int i = 0; i <= names.Count - 1; i++)
{
string name = names[i];
string value = null;
// if name is null and delimiter is '"', use a default property name 'UnspecifiedName'
if (name.Length == 0 && delimiterlocal == '"')
{
name = UnspecifiedName + unspecifiedNameIndex;
unspecifiedNameIndex++;
}
// if name is null and delimiter is not '"', use a default property name 'UnspecifiedName'
if (string.IsNullOrEmpty(name))
{
name = UnspecifiedName + unspecifiedNameIndex;
unspecifiedNameIndex++;
}
// If no value was present in CSV file, we write null.
if (i < values.Count)
{
value = values[i];
}
result.Properties.Add(new PSNoteProperty(name, value), preValidated);
}
if (!_alreadyWarnedUnspecifiedName && unspecifiedNameIndex != 1)
{
_cmdlet.WriteWarning(CsvCommandStrings.UseDefaultNameForUnspecifiedHeader);
_alreadyWarnedUnspecifiedName = true;
}
if (!string.IsNullOrEmpty(type))
{
result.TypeNames.Clear();
result.TypeNames.Add(type);
result.TypeNames.Add(ImportExportCSVHelper.CSVTypePrefix + type);
}
return result;
}
}
#endregion ImportHelperConversion
#region ExportImport Helper
/// <summary>
/// Helper class for CSV conversion.
/// </summary>
internal static class ImportExportCSVHelper
{
internal const char CSVDelimiter = ',';
internal const string CSVTypePrefix = "CSV:";
internal static char SetDelimiter(PSCmdlet cmdlet, string parameterSetName, char explicitDelimiter, bool useCulture)
{
char delimiter = explicitDelimiter;
switch (parameterSetName)
{
case "Delimiter":
case "DelimiterPath":
case "DelimiterLiteralPath":
// if delimiter is not given, it should take , as value
if (explicitDelimiter == '\0')
{
delimiter = ImportExportCSVHelper.CSVDelimiter;
}
break;
case "UseCulture":
case "CulturePath":
case "CultureLiteralPath":
if (useCulture)
{
// ListSeparator is apparently always a character even though the property returns a string, checked via:
// [CultureInfo]::GetCultures("AllCultures") | % { ([CultureInfo]($_.Name)).TextInfo.ListSeparator } | ? Length -ne 1
delimiter = CultureInfo.CurrentCulture.TextInfo.ListSeparator[0];
}
break;
default:
{
delimiter = ImportExportCSVHelper.CSVDelimiter;
}
break;
}
return delimiter;
}
}
#endregion ExportImport Helper
#endregion CSV conversion
}
|