1 package C4::ImportExportFramework;
3 # Copyright 2010-2011 MASmedios.com y Ministerio de Cultura
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use XML::LibXML::XPathContext;
25 use POSIX qw(strftime);
31 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
34 $VERSION = 3.07.00.049; # set version for version checking
45 use constant XMLSTR => '<?xml version="1.0" encoding="UTF-8"?>
46 <?mso-application progid="Excel.Sheet"?>
48 xmlns:x="urn:schemas-microsoft-com:office:excel"
49 xmlns="urn:schemas-microsoft-com:office:spreadsheet"
50 xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet">
53 <Style ss:ID="Default" ss:Name="Normal">
54 <Alignment ss:Vertical="Bottom"/>
62 <Font x:Family="Swiss" ss:Color="#0000FF" ss:Bold="1"/>
65 <NumberFormat ss:Format="yyyy\-mm\-dd"/>
68 <NumberFormat ss:Format="yyyy\-mm\-dd\ hh:mm:ss"/>
71 <NumberFormat ss:Format="hh:mm:ss"/>
79 use constant ODSSTR => '<?xml version="1.0" encoding="UTF-8"?>
80 <office:document-content xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dom="http://www.w3.org/2001/xml-events" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" office:version="1.0">
82 <office:font-face-decls/>
83 <office:automatic-styles/>
84 </office:document-content>';
87 use constant ODS_STYLES_STR => '<?xml version="1.0" encoding="UTF-8"?>
88 <office:document-styles xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dom="http://www.w3.org/2001/xml-events" office:version="1.0">
89 <office:font-face-decls></office:font-face-decls>
90 <office:styles></office:styles>
91 <office:automatic-styles></office:automatic-styles>
92 <office:master-styles></office:master-styles>
93 </office:document-styles>';
96 use constant ODS_SETTINGS_STR => '<?xml version="1.0" encoding="UTF-8"?>
97 <office:document-settings xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:config="urn:oasis:names:tc:opendocument:xmlns:config:1.0" xmlns:ooo="http://openoffice.org/2004/office" office:version="1.0"><office:settings>
98 <config:config-item-set config:name="ooo:view-settings">
99 <config:config-item config:name="VisibleAreaTop" config:type="int">0</config:config-item>
100 <config:config-item config:name="VisibleAreaLeft" config:type="int">0</config:config-item>
101 <config:config-item config:name="VisibleAreaWidth" config:type="int">2000</config:config-item>
102 <config:config-item config:name="VisibleAreaHeight" config:type="int">900</config:config-item>
103 <config:config-item-map-indexed config:name="Views"><config:config-item-map-entry>
104 <config:config-item config:name="ViewId" config:type="string">View1</config:config-item>
105 <config:config-item-map-named config:name="Tables">
106 <config:config-item-map-entry config:name="Sheet1"><config:config-item config:name="CursorPositionX" config:type="int">0</config:config-item><config:config-item config:name="CursorPositionY" config:type="int">1</config:config-item><config:config-item config:name="HorizontalSplitMode" config:type="short">0</config:config-item><config:config-item config:name="VerticalSplitMode" config:type="short">0</config:config-item><config:config-item config:name="HorizontalSplitPosition" config:type="int">0</config:config-item><config:config-item config:name="VerticalSplitPosition" config:type="int">0</config:config-item><config:config-item config:name="ActiveSplitRange" config:type="short">2</config:config-item><config:config-item config:name="PositionLeft" config:type="int">0</config:config-item><config:config-item config:name="PositionRight" config:type="int">0</config:config-item><config:config-item config:name="PositionTop" config:type="int">0</config:config-item><config:config-item config:name="PositionBottom" config:type="int">0</config:config-item>
107 </config:config-item-map-entry>
108 </config:config-item-map-named>
109 <config:config-item config:name="ActiveTable" config:type="string">Sheet1</config:config-item>
110 <config:config-item config:name="HorizontalScrollbarWidth" config:type="int">270</config:config-item>
111 <config:config-item config:name="ZoomType" config:type="short">0</config:config-item>
112 <config:config-item config:name="ZoomValue" config:type="int">100</config:config-item>
113 <config:config-item config:name="PageViewZoomValue" config:type="int">50</config:config-item>
114 <config:config-item config:name="ShowPageBreakPreview" config:type="boolean">false</config:config-item>
115 <config:config-item config:name="ShowZeroValues" config:type="boolean">true</config:config-item>
116 <config:config-item config:name="ShowNotes" config:type="boolean">true</config:config-item>
117 <config:config-item config:name="ShowGrid" config:type="boolean">true</config:config-item>
118 <config:config-item config:name="GridColor" config:type="long">12632256</config:config-item>
119 <config:config-item config:name="ShowPageBreaks" config:type="boolean">true</config:config-item>
120 <config:config-item config:name="HasColumnRowHeaders" config:type="boolean">true</config:config-item>
121 <config:config-item config:name="HasSheetTabs" config:type="boolean">true</config:config-item>
122 <config:config-item config:name="IsOutlineSymbolsSet" config:type="boolean">true</config:config-item>
123 <config:config-item config:name="IsSnapToRaster" config:type="boolean">false</config:config-item>
124 <config:config-item config:name="RasterIsVisible" config:type="boolean">false</config:config-item>
125 <config:config-item config:name="IsRasterAxisSynchronized" config:type="boolean">true</config:config-item></config:config-item-map-entry></config:config-item-map-indexed>
126 </config:config-item-set>
127 <config:config-item-set config:name="ooo:configuration-settings">
128 <config:config-item config:name="ShowZeroValues" config:type="boolean">true</config:config-item>
129 <config:config-item config:name="ShowNotes" config:type="boolean">true</config:config-item>
130 <config:config-item config:name="ShowGrid" config:type="boolean">true</config:config-item>
131 <config:config-item config:name="GridColor" config:type="long">12632256</config:config-item>
132 <config:config-item config:name="ShowPageBreaks" config:type="boolean">true</config:config-item>
133 <config:config-item config:name="LinkUpdateMode" config:type="short">3</config:config-item>
134 <config:config-item config:name="HasColumnRowHeaders" config:type="boolean">true</config:config-item>
135 <config:config-item config:name="HasSheetTabs" config:type="boolean">true</config:config-item>
136 <config:config-item config:name="IsOutlineSymbolsSet" config:type="boolean">true</config:config-item>
137 <config:config-item config:name="IsSnapToRaster" config:type="boolean">false</config:config-item>
138 <config:config-item config:name="RasterIsVisible" config:type="boolean">false</config:config-item>
139 <config:config-item config:name="IsRasterAxisSynchronized" config:type="boolean">true</config:config-item>
140 <config:config-item config:name="AutoCalculate" config:type="boolean">true</config:config-item>
141 <config:config-item config:name="PrinterName" config:type="string">Generic Printer</config:config-item>
142 <config:config-item config:name="ApplyUserData" config:type="boolean">true</config:config-item>
143 <config:config-item config:name="CharacterCompressionType" config:type="short">0</config:config-item>
144 <config:config-item config:name="SaveVersionOnClose" config:type="boolean">false</config:config-item>
145 <config:config-item config:name="UpdateFromTemplate" config:type="boolean">false</config:config-item>
146 <config:config-item config:name="AllowPrintJobCancel" config:type="boolean">true</config:config-item>
147 <config:config-item config:name="LoadReadonly" config:type="boolean">false</config:config-item>
148 </config:config-item-set>
149 </office:settings></office:document-settings>';
152 use constant ODS_MANIFEST_STR => '<?xml version="1.0" encoding="UTF-8"?>
153 <manifest:manifest xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
154 <manifest:file-entry manifest:media-type="application/vnd.oasis.opendocument.spreadsheet" manifest:full-path="/"/>
155 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/statusbar/"/>
156 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/accelerator/"/>
157 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/floater/"/>
158 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/popupmenu/"/>
159 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/progressbar/"/>
160 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/menubar/"/>
161 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/toolbar/"/>
162 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/images/Bitmaps/"/>
163 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/images/"/>
164 <manifest:file-entry manifest:media-type="application/vnd.sun.xml.ui.configuration" manifest:full-path="Configurations2/"/>
165 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="content.xml"/>
166 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="styles.xml"/>
167 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="meta.xml"/>
168 <manifest:file-entry manifest:media-type="" manifest:full-path="Thumbnails/"/>
169 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="settings.xml"/>
170 </manifest:manifest>';
175 C4::ImportExportFramework - Import/Export Framework to Excel-xml/ODS Module Functions
179 use C4::ImportExportFramework;
183 Module to Import/Export Framework to Excel-xml/ODS on intranet administration - MARC Frameworks section
185 Module to Import/Export Framework to Excel-xml/ODS on intranet administration - MARC Frameworks section
186 exporting the tables marc_tag_structure, marc_subfield_structure to excel-xml/ods or viceversa
188 Functions for handling import/export.
195 =head2 ExportFramework
197 Export all the information of a Framework to an excel "xml" file or OpenDocument SpreadSheet "ods" file.
206 my ($frameworkcode, $xmlStrRef, $mode) = @_;
208 my $dbh = C4::Context->dbh;
213 if ($mode eq 'ods' || $mode eq 'excel') {
215 my $parser = XML::LibXML->new();
216 $dom = $parser->parse_string(($mode && $mode eq 'ods')?ODSSTR:XMLSTR);
218 $root = $dom->documentElement();
219 if ($mode && $mode eq 'ods') {
220 my $elementBody = $dom->createElement('office:body');
221 $root->appendChild($elementBody);
222 $elementSS = $dom->createElement('office:spreadsheet');
223 $elementBody->appendChild($elementSS);
228 $debug and warn "Error ExportFramework $@\n";
233 if (_export_table('marc_tag_structure', $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode)) {
234 if (_export_table('marc_subfield_structure', $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode)) {
235 $$xmlStrRef = $dom->toString(1) if ($mode eq 'ods' || $mode eq 'excel');
246 # Export all the data from a mysql table to an spreadsheet.
249 my ($table, $dbh, $dom, $root, $frameworkcode, $mode) = @_;
250 if ($mode eq 'csv') {
251 _export_table_csv($table, $dbh, $dom, $root, $frameworkcode);
252 } elsif ($mode eq 'ods') {
253 _export_table_ods($table, $dbh, $dom, $root, $frameworkcode);
255 _export_table_excel($table, $dbh, $dom, $root, $frameworkcode);
259 # Export the mysql table to an csv file
260 sub _export_table_csv
262 my ($table, $dbh, $strCSV, $root, $frameworkcode) = @_;
265 # First row with the name of the columns
266 my $query = 'SHOW COLUMNS FROM ' . $table;
267 my $sth = $dbh->prepare($query);
270 while (my $hashRef = $sth->fetchrow_hashref) {
271 $$strCSV .= '"' . $hashRef->{Field} . '",';
272 push @fields, $hashRef->{Field};
276 # Populate rows with the data from mysql
277 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
278 $sth = $dbh->prepare($query);
279 $sth->execute($frameworkcode);
281 while (my $hashRef = $sth->fetchrow_hashref) {
282 for my $field (@fields) {
283 my $value = $hashRef->{$field} // q||;
284 $value =~ s/[\r\n]//g;
285 $$strCSV .= '"' . $value . '",';
292 # Separator for change of table
293 $$strCSV .= '"#-#",';
300 $debug and warn "Error _export_table_csv $@\n";
307 # Export the mysql table to an ods file
308 sub _export_table_ods
310 my ($table, $dbh, $dom, $root, $frameworkcode) = @_;
313 my $elementTable = $dom->createElement('table:table');
314 $elementTable->setAttribute('table:name', $table);
315 $elementTable->setAttribute('table:print', 'false');
316 $root->appendChild($elementTable);
317 my $elementRow = $dom->createElement('table:table-row');
318 $elementTable->appendChild($elementRow);
322 # First row with the name of the columns
323 my $query = 'SHOW COLUMNS FROM ' . $table;
324 my $sth = $dbh->prepare($query);
327 while (my $hashRef = $sth->fetchrow_hashref) {
328 $elementCell = $dom->createElement('table:table-cell');
329 $elementCell->setAttribute('office:value-type', 'string');
330 $elementCell->setAttribute('office:value', $hashRef->{Field});
331 $elementRow->appendChild($elementCell);
332 $elementData = $dom->createElement('text:p');
333 $elementCell->appendChild($elementData);
334 $elementData->appendTextNode($hashRef->{Field});
335 push @fields, {name => $hashRef->{Field}, type => ($hashRef->{Type} =~ /int/i)?'float':'string'};
337 # Populate rows with the data from mysql
338 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
339 $sth = $dbh->prepare($query);
340 $sth->execute($frameworkcode);
342 while (my $hashRef = $sth->fetchrow_hashref) {
343 $elementRow = $dom->createElement('table:table-row');
344 $elementTable->appendChild($elementRow);
346 $data = $hashRef->{$_->{name}};
347 if ($_->{type} eq 'float' && !defined($data)) {
349 } elsif ($_->{type} eq 'string' && (!$data && $data ne '0')) {
352 $data = _parseContent2Xml($data) if ($_->{type} eq 'string');
353 $elementCell = $dom->createElement('table:table-cell');
354 $elementCell->setAttribute('office:value-type', $_->{type});
355 $elementCell->setAttribute('office:value', $data);
356 $elementRow->appendChild($elementCell);
357 $elementData = $dom->createElement('text:p');
358 $elementCell->appendChild($elementData);
359 $elementData->appendTextNode($data);
364 $debug and warn "Error _export_table_ods $@\n";
371 # Export the mysql table to an excel-xml (openoffice/libreoffice compatible) file
372 sub _export_table_excel
374 my ($table, $dbh, $dom, $root, $frameworkcode) = @_;
377 my $elementWS = $dom->createElement('Worksheet');
378 $elementWS->setAttribute('ss:Name', $table);
379 $root->appendChild($elementWS);
380 my $elementTable = $dom->createElement('ss:Table');
381 $elementWS->appendChild($elementTable);
382 my $elementRow = $dom->createElement('ss:Row');
383 $elementTable->appendChild($elementRow);
385 # First row with the name of the columns
388 my $query = 'SHOW COLUMNS FROM ' . $table;
389 my $sth = $dbh->prepare($query);
392 while (my $hashRef = $sth->fetchrow_hashref) {
393 $elementCell = $dom->createElement('ss:Cell');
394 $elementCell->setAttribute('ss:StyleID', 's27');
395 $elementRow->appendChild($elementCell);
396 $elementData = $dom->createElement('ss:Data');
397 $elementData->setAttribute('ss:Type', 'String');
398 $elementCell->appendChild($elementData);
399 $elementData->appendTextNode($hashRef->{Field});
400 push @fields, {name => $hashRef->{Field}, type => ($hashRef->{Type} =~ /int/i)?'Number':'String'};
402 # Populate rows with the data from mysql
403 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
404 $sth = $dbh->prepare($query);
405 $sth->execute($frameworkcode);
407 while (my $hashRef = $sth->fetchrow_hashref) {
408 $elementRow = $dom->createElement('ss:Row');
409 $elementTable->appendChild($elementRow);
411 $elementCell = $dom->createElement('ss:Cell');
412 $elementRow->appendChild($elementCell);
413 $elementData = $dom->createElement('ss:Data');
414 $elementData->setAttribute('ss:Type', $_->{type});
415 $elementCell->appendChild($elementData);
416 $data = $hashRef->{$_->{name}};
417 if ($_->{type} eq 'Number' && !defined($data)) {
419 } elsif ($_->{type} eq 'String' && (!$data && $data ne '0')) {
422 $elementData->appendTextNode(($_->{type} eq 'String')?_parseContent2Xml($data):$data);
427 $debug and warn "Error _export_table_excel $@\n";
431 }#_export_table_excel
439 # Format chars problematics to a correct format for xml.
440 sub _parseContent2Xml
444 $content =~ s/\&(?![a-zA-Z#0-9]{1,4};)/&/g;
445 $content =~ s/</</g;
446 $content =~ s/>/>/g;
451 # Get the tmp directory on the system
455 if ($ENV{'TMP'} && -d $ENV{'TMP'}) {
457 } elsif ($ENV{'TMPDIR'} && -d $ENV{'TMPDIR'}) {
458 $tmp = $ENV{'TMPDIR'};
459 } elsif ($ENV{'TEMP'} && -d $ENV{'TEMP'}) {
466 # Create our tempdir directory for the ods process
471 my $tempdir = (-d $tmp)?$tmp . '/':'./';
472 $tempdir .= 'tmp_ods_' . Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
485 Creates a temporary directory to create the ods file and read it to store its content in a string.
494 my ($strContent, $lang, $strODSRef) = @_;
501 import File::Temp qw/ tempfile tempdir /;
502 $tempdir = tempdir ( 'tmp_ods_' . $$ . '_XXXXXXXX', DIR => (-d $tmp)?$tmp:'.', CLEANUP => 1);
506 $tempdir = _createTmpDir($tmp);
510 # populate tempdir directory with the ods elements
512 if (open($fh, '>', "$tempdir/content.xml")) {
513 print {$fh} $strContent;
516 if (open($fh, '>', "$tempdir/mimetype")) {
517 print {$fh} 'application/vnd.oasis.opendocument.spreadsheet';
520 if (open($fh, '>', "$tempdir/meta.xml")) {
521 print {$fh} _getMeta($lang);
524 if (open($fh, '>', "$tempdir/styles.xml")) {
525 print {$fh} ODS_STYLES_STR;
528 if (open($fh, '>', "$tempdir/settings.xml")) {
529 print {$fh} ODS_SETTINGS_STR;
532 mkdir($tempdir.'/META-INF/');
533 mkdir($tempdir.'/Configurations2/');
534 mkdir($tempdir.'/Configurations2/acceleator/');
535 mkdir($tempdir.'/Configurations2/images/');
536 mkdir($tempdir.'/Configurations2/popupmenu/');
537 mkdir($tempdir.'/Configurations2/statusbar/');
538 mkdir($tempdir.'/Configurations2/floater/');
539 mkdir($tempdir.'/Configurations2/menubar/');
540 mkdir($tempdir.'/Configurations2/progressbar/');
541 mkdir($tempdir.'/Configurations2/toolbar/');
543 if (open($fh, '>', "$tempdir/META-INF/manifest.xml")) {
544 print {$fh} ODS_MANIFEST_STR;
549 $debug and warn "Error createODS $@\n";
551 # create ods file from tempdir directory
553 require Archive::Zip;
554 import Archive::Zip qw( :ERROR_CODES :CONSTANTS );
555 my $zip = Archive::Zip->new();
556 $zip->addTree( $tempdir, '' );
557 $zip->writeToFileNamed($tempdir . '/new.ods');
560 my $cmd = qx(which zip 2>/dev/null || whereis zip);
562 $cmd = 'zip' if (!$cmd || !-x $cmd);
563 system("cd $tempdir && $cmd -r new.ods ./");
566 # read ods file and return as a string
567 if (-f "$tempdir/new.ods") {
568 if (open ($fh, '<', "$tempdir/new.ods")) {
571 while (read ($fh, $buffer, 65536)) {
572 $$strODSRef .= $buffer;
578 # delete tempdir directory
579 if (!$tempModule && $tempdir) {
582 import File::Temp qw/ rmtree /;
586 system("rm -rf $tempdir");
596 # return Meta content for ods file
601 my $myDate = strftime ("%Y-%m-%dT%H:%M:%S", localtime(time()));
602 my $meta = '<?xml version="1.0" encoding="UTF-8"?>
603 <office:document-meta xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:ooo="http://openoffice.org/2004/office" office:version="1.0">
605 <meta:generator>ods-php</meta:generator>
606 <meta:creation-date>' . $myDate . '</meta:creation-date>
607 <dc:date>' . $myDate . '</dc:date>
608 <dc:language>' . $lang . '</dc:language>
609 <meta:editing-cycles>2</meta:editing-cycles>
610 <meta:editing-duration>PT15S</meta:editing-duration>
611 <meta:user-defined meta:name="Info 1"/>
612 <meta:user-defined meta:name="Info 2"/>
613 <meta:user-defined meta:name="Info 3"/>
614 <meta:user-defined meta:name="Info 4"/>
616 </office:document-meta>';
621 =head2 ImportFramework
623 Import all the information of a Framework from a excel-xml/ods file.
632 my ($filename, $frameworkcode, $deleteFilename) = @_;
636 my $dbh = C4::Context->dbh;
637 if (-r $filename && $dbh) {
639 if ($filename =~ /\.(csv|ods|xml)$/i) {
642 unlink ($filename) if ($deleteFilename); # remove temporary file
645 if ($extension eq 'ods') {
646 ($tempdir, $filename) = _openODS($filename, $deleteFilename);
651 if ($extension eq 'ods' || $extension eq 'xml') {
652 # They have xml structure, so read it on a dom object
653 my $parser = XML::LibXML->new();
654 $dom = $parser->parse_file($filename);
656 my $root = $dom->documentElement();
659 # They are text files, so open it to read
660 open($dom, '<', $filename);
663 # Process both tables
665 my $numDeletedAux = 0;
666 if (($numDeletedAux = _import_table($dbh, 'marc_tag_structure', $frameworkcode, $dom, ['frameworkcode', 'tagfield'], $extension)) >= 0) {
667 $numDeleted += $numDeletedAux if ($numDeletedAux > 0);
668 if (($numDeletedAux = _import_table($dbh, 'marc_subfield_structure', $frameworkcode, $dom, ['frameworkcode', 'tagfield', 'tagsubfield'], $extension)) >= 0) {
669 $numDeleted += $numDeletedAux if ($numDeletedAux > 0);
670 $ok = ($numDeleted > 0)?$numDeleted:0;
674 $debug and warn "Error ImportFramework couldn't create dom\n";
678 $debug and warn "Error ImportFramework $@\n";
680 if ($extension eq 'csv') {
681 close($dom) if ($dom);
685 unlink ($filename) if ($deleteFilename); # remove temporary file
687 $debug and warn "Error ImportFramework no conex to database or not readeable $filename\n";
689 if ($deleteFilename && $tempdir && -d $tempdir && -w $tempdir) {
692 import File::Temp qw/ rmtree /;
696 system("rm -rf $tempdir");
702 # Open (uncompress) ods file and return the content.xml file
705 my ($filename, $deleteFilename) = @_;
712 import File::Temp qw/ tempfile tempdir /;
713 $tempdir = tempdir ( 'tmp_ods_' . $$ . '_XXXXXXXX', DIR => (-d $tmp)?$tmp:'.', CLEANUP => 1);
717 $tempdir = _createTmpDir($tmp);
721 require Archive::Zip;
722 import Archive::Zip qw( :ERROR_CODES :CONSTANTS );
723 my $zip = Archive::Zip->new($filename);
724 foreach my $file ($zip->members) {
725 next if ($file->isDirectory);
726 (my $extractName = $file->fileName) =~ s{.*/}{};
727 next unless ($extractName eq 'content.xml');
728 $file->extractToFileNamed("$tempdir/$extractName");
732 my $cmd = qx(which unzip 2>/dev/null || whereis unzip);
734 $cmd = 'unzip' if (!$cmd || !-x $cmd);
735 system("$cmd $filename -d $tempdir");
737 if (-f "$tempdir/content.xml") {
738 unlink ($filename) if ($deleteFilename);
739 return ($tempdir, "$tempdir/content.xml");
742 unlink ($filename) if ($deleteFilename);
743 return ($tempdir, undef);
748 # Check the table and columns corresponds with worksheet
749 sub _check_validity_worksheet
751 my ($dbh, $table, $nodeFields, $fieldsA, $format) = @_;
755 my $query = 'DESCRIBE ' . $table;
756 my $sth = $dbh->prepare($query);
759 $query = 'SHOW COLUMNS FROM ' . $table;
760 $sth = $dbh->prepare($query);
763 while (my $hashRef = $sth->fetchrow_hashref) {
764 $fields->{$hashRef->{Field}} = $hashRef->{Field};
772 _getFields($nodeFields, $fieldsR, $format);
776 unless (exists($fields->{$_})) {
783 }#_check_validity_worksheet
786 # Import the data from an excel-xml/ods to mysql tables.
789 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $format) = @_;
793 # Create hash with all elements defined by primary key to know which ones to delete after parsing the spreadsheet
797 $query = 'SELECT ' . join(',', @fields) . ' FROM ' . $table . ' WHERE frameworkcode=?';
798 my $sth = $dbh->prepare($query);
799 $sth->execute($frameworkcode);
801 while (my $hashRef = $sth->fetchrow_hashref) {
803 map { $field .= $hashRef->{$_} . '_'; } @fields;
805 $fields2Delete{$field} = 1;
810 if ($format eq 'csv') {
813 my $query = 'SHOW COLUMNS FROM ' . $table;
814 my $sth = $dbh->prepare($query);
816 while (my $hashRef = $sth->fetchrow_hashref) {
817 push @fieldsName, $hashRef->{Field};
820 $ok = _import_table_csv($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete, \@fieldsName);
821 } elsif ($format eq 'ods') {
822 $ok = _import_table_ods($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete);
824 $ok = _import_table_excel($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete);
827 if (($ok = scalar(keys %fields2Delete)) > 0) {
828 $query = 'DELETE FROM ' . $table . ' WHERE ';
829 map {$query .= $_ . '=? AND ';} @$PKArray;
830 $query = substr($query, 0, -4);
831 my $sth = $dbh->prepare($query);
832 for (keys %fields2Delete) {
834 $sth->execute(($frameworkcode, split('_', $_)));
845 # Insert/Update the row from the spreadsheet in the database
848 my ($dbh, $db_scheme, $table, $fields, $dataStr, $updateStr, $dataFields, $dataFieldsHash, $PKArray, $fieldsPK, $fields2Delete) = @_;
852 if ($db_scheme eq 'mysql') {
853 $query = 'INSERT INTO ' . $table . ' (' . $fields . ') VALUES (' . $dataStr . ') ON DUPLICATE KEY UPDATE ' . $updateStr;
855 $query = 'INSERT INTO ' . $table . ' (' . $fields . ') VALUES (' . $dataStr . ')';
858 my $sth = $dbh->prepare($query);
859 if ($db_scheme eq 'mysql') {
860 $sth->execute((@$dataFields, @$dataFields));
862 $sth->execute(@$dataFields);
866 unless ($db_scheme eq 'mysql') {
867 $query = 'UPDATE ' . $table . ' SET ' . $updateStr . ' WHERE ';
868 map {$query .= $_ . '=? AND ';} @$PKArray;
869 $query = substr($query, 0, -4);
871 my $sth2 = $dbh->prepare($query);
873 map {push @dataPK, $dataFieldsHash->{$_};} @$PKArray;
874 $sth2->execute((@$dataFields, @dataPK));
878 $debug and warn "Error _processRows_Table $@\n";
884 map { $field .= $dataFieldsHash->{$_} . '_'; } @$fieldsPK;
886 delete $fields2Delete->{$field} if (exists($fields2Delete->{$field}));
892 # Process the rows of a worksheet and insert/update them in a mysql table.
893 sub _processRows_Table
895 my ($dbh, $frameworkcode, $nodeR, $table, $PKArray, $format, $fields2Delete) = @_;
903 my $db_scheme = C4::Context->config("db_scheme");
905 my @fieldsPK = @$PKArray;
908 if ($nodeR->nodeType == 1 && (($format && $format eq 'ods' && $nodeR->nodeName =~ /(?:table:)?table-row/) || ($nodeR->nodeName =~ /(?:ss:)?Row/)) && $nodeR->hasChildNodes()) {
911 _getFields($nodeR, \@fields, $format);
912 return 0 unless _check_validity_worksheet($dbh, $table, $nodeR, \@fields, $format);
913 $fields = join(',', @fields);
915 map { $dataStr .= '?,';} @fields;
916 chop($dataStr) if ($dataStr);
918 map { $updateStr .= $_ . '=?,';} @fields;
919 chop($updateStr) if ($updateStr);
922 my ($dataFields, $dataFieldsR) = _getDataFields($frameworkcode, $nodeR, \@fields, $format);
923 if (scalar(@fields) == scalar(@$dataFieldsR)) {
924 $ok = _processRow_DB($dbh, $db_scheme, $table, $fields, $dataStr, $updateStr, $dataFieldsR, $dataFields, $PKArray, \@fieldsPK, $fields2Delete);
929 $nodeR = $nodeR->nextSibling;
937 # Import worksheet from the csv file to the mysql table
938 sub _import_table_csv
940 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete, $fields) = @_;
944 my $numFields = @$fields;
945 my $fieldsNameRead = 0;
947 my ($fieldsStr, $dataStr, $updateStr);
948 my $db_scheme = C4::Context->config("db_scheme");
949 my @fieldsPK = @$PKArray;
956 # Check whether the line has an unfinished field, i.e., a field with CR/LF in its data
957 if ($row =~ /,"[^"]*[\r\n]+$/ || $row =~ /^[^"]+[\r\n]+$/) {
958 $row =~ s/[\r\n]+$//;
963 $row = $partialRow . $row;
966 # Line OK, process it
967 if ($row =~ /(?:".*?",?)+/) {
968 @arrData = split('","', $row);
969 $arrData[0] = substr($arrData[0], 1) if ($arrData[0] =~ /^"/);
970 $arrData[$#arrData] =~ s/[\r\n]+$//;
971 chop $arrData[$#arrData] if ($arrData[$#arrData] =~ /"$/);
973 if ($arrData[0] eq '#-#' && $arrData[$#arrData] eq '#-#') {
974 # Change of table with separators #-#
976 } elsif ($fieldsNameRead && $arrData[0] eq 'tagfield') {
977 # Change of table because we begin with field name with former field names read
981 if (scalar(@$fields) == scalar(@arrData)) {
982 if (!$fieldsNameRead) {
983 # New table, we read the field names
985 for (my $i=0; $i < @arrData; $i++) {
986 if ($arrData[$i] ne $fields->[$i]) {
991 if ($fieldsNameRead) {
992 $fieldsStr = join(',', @$fields);
994 map { $dataStr .= '?,';} @$fields;
995 chop($dataStr) if ($dataStr);
997 map { $updateStr .= $_ . '=?,';} @$fields;
998 chop($updateStr) if ($updateStr);
1003 my %dataFields = ();
1005 if ($fields->[$j] eq 'frameworkcode' && $_ ne $frameworkcode) {
1006 $dataFields{$fields->[$j]} = $frameworkcode;
1007 $arrData[$j] = $frameworkcode;
1009 $dataFields{$fields->[$j]} = $_;
1013 $ok = _processRow_DB($dbh, $db_scheme, $table, $fieldsStr, $dataStr, $updateStr, \@arrData, \%dataFields, $PKArray, \@fieldsPK, $fields2Delete);
1026 # Import worksheet from the ods content.xml file to the mysql table
1027 sub _import_table_ods
1029 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete) = @_;
1031 my $xc = XML::LibXML::XPathContext->new($dom);
1032 $xc->registerNs('xmlns:office','urn:oasis:names:tc:opendocument:xmlns:office:1.0');
1033 $xc->registerNs('xmlns:table','urn:oasis:names:tc:opendocument:xmlns:table:1.0');
1034 $xc->registerNs('xmlns:text','urn:oasis:names:tc:opendocument:xmlns:text:1.0');
1036 @nodes = $xc->findnodes('//table:table[@table:name="' . $table . '"]');
1037 if (@nodes == 1 && $nodes[0]->hasChildNodes()) {
1038 my $nodeR = $nodes[0]->firstChild;
1039 return _processRows_Table($dbh, $frameworkcode, $nodeR, $table, $PKArray, 'ods', $fields2Delete);
1041 $debug and warn "Error _import_table_ods there's not worksheet for $table\n";
1047 # Import worksheet from the excel-xml file to the mysql table
1048 sub _import_table_excel
1050 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete) = @_;
1052 my $xc = XML::LibXML::XPathContext->new($dom);
1053 $xc->registerNs('xmlns','urn:schemas-microsoft-com:office:spreadsheet');
1054 $xc->registerNs('xmlns:ss','urn:schemas-microsoft-com:office:spreadsheet');
1055 $xc->registerNs('xmlns:x','urn:schemas-microsoft-com:office:excel');
1057 @nodes = $xc->findnodes('//ss:Worksheet[@ss:Name="' . $table . '"]');
1059 for (my $i=0; $i < @nodes; $i++) {
1060 my @nodesT = $nodes[$i]->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Table');
1061 if (@nodesT == 1 && $nodesT[0]->hasChildNodes()) {
1062 my $nodeR = $nodesT[0]->firstChild;
1063 return _processRows_Table($dbh, $frameworkcode, $nodeR, $table, $PKArray, undef, $fields2Delete);
1067 $debug and warn "Error _import_table_excel there's not worksheet for $table\n";
1070 }#_import_table_excel
1073 # Get the data from a cell on a ods file through the value attribute or the text node
1080 if ($node->nodeType == 1 && $node->nodeName =~ /(?:table:)?table-cell/) {
1081 if ($node->hasAttributeNS('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'value')) {
1082 $data = $node->getAttributeNS('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'value');
1083 } elsif ($node->hasChildNodes()) {
1084 my @nodes2 = $node->getElementsByTagNameNS('urn:oasis:names:tc:opendocument:xmlns:text:1.0', 'p');
1085 if (@nodes2 == 1 && $nodes2[0]->hasChildNodes()) {
1086 $data = $nodes2[0]->firstChild->nodeValue;
1089 if ($node->hasAttributeNS('urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'number-columns-repeated')) {
1090 $repeated = $node->getAttributeNS('urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'number-columns-repeated');
1093 return ($data, $repeated);
1097 # Get the data from a row of a spreadsheet
1100 my ($frameworkcode, $node, $fields, $format) = @_;
1102 my $dataFields = {};
1103 my @dataFieldsA = ();
1104 if ($node && $node->hasChildNodes()) {
1105 my $node2 = $node->firstChild;
1106 my ($data, $repeated);
1111 if ($format && $format eq 'ods') {
1112 ($data, $repeated) = _getDataNodeODS($node2) if ($repeated <= 0);
1114 $ok = 1 if (defined($data));
1116 if ($node2->nodeType == 1 && $node2->nodeName =~ /(?:ss:)?Cell/) {
1117 my @nodes3 = $node2->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Data');
1118 if (@nodes3 == 1 && $nodes3[0]->hasChildNodes()) {
1119 $data = $nodes3[0]->firstChild->nodeValue;
1125 $data = '' if ($data eq '#');
1126 $data = $frameworkcode if ($fields->[$i] eq 'frameworkcode');
1127 $dataFields->{$fields->[$i]} = $data;
1128 push @dataFieldsA, $data;
1132 $node2 = $node2->nextSibling if ($repeated <= 0);
1135 return ($dataFields, \@dataFieldsA);
1139 # Get the data from the first row to know the column names
1142 my ($node, $fields, $format) = @_;
1144 if ($node && $node->hasChildNodes()) {
1145 my $node2 = $node->firstChild;
1146 my ($data, $repeated);
1148 if ($format && $format eq 'ods') {
1149 ($data, $repeated) = _getDataNodeODS($node2);
1150 push @$fields, $data if (defined($data));
1152 if ($node2->nodeType == 1 && $node2->nodeName =~ /(?:ss:)?Cell/) {
1153 my @nodes3 = $node2->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Data');
1154 if (@nodes3 == 1 && $nodes3[0]->hasChildNodes()) {
1155 $data = $nodes3[0]->firstChild->nodeValue;
1156 push @$fields, $data;
1160 $node2 = $node2->nextSibling;
1173 Koha Development Team <http://koha-community.org/>