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
|
# --
# Kernel/System/CSV.pm - all csv functions
# Copyright (C) 2001-2008 OTRS AG, http://otrs.org/
# --
# $Id: CSV.pm,v 1.10.2.2 2008/03/10 11:58:56 tr Exp $
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see http://www.gnu.org/licenses/gpl-2.0.txt.
# --
package Kernel::System::CSV;
use strict;
use vars qw(@ISA $VERSION);
$VERSION = '$Revision: 1.10.2.2 $';
$VERSION =~ s/^\$.*:\W(.*)\W.+?$/$1/;
=head1 NAME
Kernel::System::CSV - CVS lib
=head1 SYNOPSIS
All csv functions.
=head1 PUBLIC INTERFACE
=over 4
=item new()
create a object
use Kernel::Config;
use Kernel::System::Log;
use Kernel::System::CSV;
my $ConfigObject = Kernel::Config->new();
my $LogObject = Kernel::System::Log->new(
ConfigObject => $ConfigObject,
);
my $CSVObject = Kernel::System::CSV->new(
LogObject => $LogObject,
);
=cut
sub new {
my $Type = shift;
my %Param = @_;
# allocate new hash for object
my $Self = {};
bless ($Self, $Type);
# check needed objects
foreach (qw(LogObject)) {
$Self->{$_} = $Param{$_} || die "Got no $_!";
}
return $Self;
}
=item Array2CSV()
Returns a csv formatted string based on a array with head data.
$CSV = $CSVObject->Array2CSV(
Head => ['RowA', 'RowB', ], # optional
Data => [
[1,4],
[7,3],
[1,9],
[34,4],
],
);
=cut
sub Array2CSV {
my $Self = shift;
my %Param = @_;
my $Output = '';
my @Head = ();
my @Data = (['##No Data##']);
# check required params
foreach (qw(Data)) {
if (!$Param{$_}) {
$Self->{LogObject}->Log(Priority => "error", Message => "Got no $_ param!");
return;
}
}
if ($Param{Head}) {
@Head = @{$Param{Head}};
}
if ($Param{Data}) {
@Data = @{$Param{Data}};
}
# if we have head param fill in header
foreach my $Entry (@Head) {
# csv quote
$Entry =~ s/"/""/g if ($Entry);
$Entry = '' if (!defined($Entry));
$Output .= "\"$Entry\";";
}
if ($Output) {
$Output .= "\n";
}
# fill in data
foreach my $EntryRow (@Data) {
foreach my $Entry (@{$EntryRow}) {
# Copy $Entry because otherwise you maniplate the content
# of the original $Param{Data}!!!! Array in Array Referenc
my $Content = $Entry;
# csv quote
$Content =~ s/"/""/g if ($Content);
$Content = '' if ( !defined($Content) );
$Output .= "\"$Content\";";
}
$Output .= "\n";
}
return $Output;
}
=item CSV2Array()
Returns an array with parsed csv data.
my $RefArray = $CSVObject->CSV2Array(
String => $CSVString,
Separator => ';', # optional separator (default is ;)
Quote => '"', # optional quote (default is ")
);
=cut
sub CSV2Array {
my $Self = shift;
my %Param = @_;
my @Array = ();
# get separator
if (!defined($Param{Separator}) || $Param{Separator} eq '') {
$Param{Separator} = ';';
}
# a better solution can be the use of
# use Text::ParseWords;
# for more information read "PerlKochbuch" page 32
# get separator
if (!defined($Param{Quote})) {
$Param{Quote} = '"';
}
# if you change the split options, remember that each value can include \n
my @Lines = split( /$Param{Quote}$Param{Separator}\n/, $Param{String} );
for my $Line (@Lines) {
my @Fields = split( /$Param{Quote}$Param{Separator}$Param{Quote}/, $Line );
$Fields[0] =~ s/^$Param{Quote}//mgs;
for my $Field (@Fields) {
$Field =~ s/$Param{Quote}$Param{Quote}/$Param{Quote}/g;
}
push( @Array, \@Fields );
}
return \@Array;
}
1;
=back
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (http://otrs.org/).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.gnu.org/licenses/gpl-2.0.txt.
=head1 VERSION
$Revision: 1.10.2.2 $ $Date: 2008/03/10 11:58:56 $
=cut
|