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 );
27 use List::MoreUtils qw( indexes );
32 our (@ISA, @EXPORT_OK);
44 use constant XMLSTR => '<?xml version="1.0" encoding="UTF-8"?>
45 <?mso-application progid="Excel.Sheet"?>
47 xmlns:x="urn:schemas-microsoft-com:office:excel"
48 xmlns="urn:schemas-microsoft-com:office:spreadsheet"
49 xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet">
52 <Style ss:ID="Default" ss:Name="Normal">
53 <Alignment ss:Vertical="Bottom"/>
61 <Font x:Family="Swiss" ss:Color="#0000FF" ss:Bold="1"/>
64 <NumberFormat ss:Format="yyyy\-mm\-dd"/>
67 <NumberFormat ss:Format="yyyy\-mm\-dd\ hh:mm:ss"/>
70 <NumberFormat ss:Format="hh:mm:ss"/>
78 use constant ODSSTR => '<?xml version="1.0" encoding="UTF-8"?>
79 <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">
81 <office:font-face-decls/>
82 <office:automatic-styles/>
83 </office:document-content>';
86 use constant ODS_STYLES_STR => '<?xml version="1.0" encoding="UTF-8"?>
87 <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">
88 <office:font-face-decls></office:font-face-decls>
89 <office:styles></office:styles>
90 <office:automatic-styles></office:automatic-styles>
91 <office:master-styles></office:master-styles>
92 </office:document-styles>';
95 use constant ODS_SETTINGS_STR => '<?xml version="1.0" encoding="UTF-8"?>
96 <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>
97 <config:config-item-set config:name="ooo:view-settings">
98 <config:config-item config:name="VisibleAreaTop" config:type="int">0</config:config-item>
99 <config:config-item config:name="VisibleAreaLeft" config:type="int">0</config:config-item>
100 <config:config-item config:name="VisibleAreaWidth" config:type="int">2000</config:config-item>
101 <config:config-item config:name="VisibleAreaHeight" config:type="int">900</config:config-item>
102 <config:config-item-map-indexed config:name="Views"><config:config-item-map-entry>
103 <config:config-item config:name="ViewId" config:type="string">View1</config:config-item>
104 <config:config-item-map-named config:name="Tables">
105 <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>
106 </config:config-item-map-entry>
107 </config:config-item-map-named>
108 <config:config-item config:name="ActiveTable" config:type="string">Sheet1</config:config-item>
109 <config:config-item config:name="HorizontalScrollbarWidth" config:type="int">270</config:config-item>
110 <config:config-item config:name="ZoomType" config:type="short">0</config:config-item>
111 <config:config-item config:name="ZoomValue" config:type="int">100</config:config-item>
112 <config:config-item config:name="PageViewZoomValue" config:type="int">50</config:config-item>
113 <config:config-item config:name="ShowPageBreakPreview" config:type="boolean">false</config:config-item>
114 <config:config-item config:name="ShowZeroValues" config:type="boolean">true</config:config-item>
115 <config:config-item config:name="ShowNotes" config:type="boolean">true</config:config-item>
116 <config:config-item config:name="ShowGrid" config:type="boolean">true</config:config-item>
117 <config:config-item config:name="GridColor" config:type="long">12632256</config:config-item>
118 <config:config-item config:name="ShowPageBreaks" config:type="boolean">true</config:config-item>
119 <config:config-item config:name="HasColumnRowHeaders" config:type="boolean">true</config:config-item>
120 <config:config-item config:name="HasSheetTabs" config:type="boolean">true</config:config-item>
121 <config:config-item config:name="IsOutlineSymbolsSet" config:type="boolean">true</config:config-item>
122 <config:config-item config:name="IsSnapToRaster" config:type="boolean">false</config:config-item>
123 <config:config-item config:name="RasterIsVisible" config:type="boolean">false</config:config-item>
124 <config:config-item config:name="IsRasterAxisSynchronized" config:type="boolean">true</config:config-item></config:config-item-map-entry></config:config-item-map-indexed>
125 </config:config-item-set>
126 <config:config-item-set config:name="ooo:configuration-settings">
127 <config:config-item config:name="ShowZeroValues" config:type="boolean">true</config:config-item>
128 <config:config-item config:name="ShowNotes" config:type="boolean">true</config:config-item>
129 <config:config-item config:name="ShowGrid" config:type="boolean">true</config:config-item>
130 <config:config-item config:name="GridColor" config:type="long">12632256</config:config-item>
131 <config:config-item config:name="ShowPageBreaks" config:type="boolean">true</config:config-item>
132 <config:config-item config:name="LinkUpdateMode" config:type="short">3</config:config-item>
133 <config:config-item config:name="HasColumnRowHeaders" config:type="boolean">true</config:config-item>
134 <config:config-item config:name="HasSheetTabs" config:type="boolean">true</config:config-item>
135 <config:config-item config:name="IsOutlineSymbolsSet" config:type="boolean">true</config:config-item>
136 <config:config-item config:name="IsSnapToRaster" config:type="boolean">false</config:config-item>
137 <config:config-item config:name="RasterIsVisible" config:type="boolean">false</config:config-item>
138 <config:config-item config:name="IsRasterAxisSynchronized" config:type="boolean">true</config:config-item>
139 <config:config-item config:name="AutoCalculate" config:type="boolean">true</config:config-item>
140 <config:config-item config:name="PrinterName" config:type="string">Generic Printer</config:config-item>
141 <config:config-item config:name="ApplyUserData" config:type="boolean">true</config:config-item>
142 <config:config-item config:name="CharacterCompressionType" config:type="short">0</config:config-item>
143 <config:config-item config:name="SaveVersionOnClose" config:type="boolean">false</config:config-item>
144 <config:config-item config:name="UpdateFromTemplate" config:type="boolean">false</config:config-item>
145 <config:config-item config:name="AllowPrintJobCancel" config:type="boolean">true</config:config-item>
146 <config:config-item config:name="LoadReadonly" config:type="boolean">false</config:config-item>
147 </config:config-item-set>
148 </office:settings></office:document-settings>';
151 use constant ODS_MANIFEST_STR => '<?xml version="1.0" encoding="UTF-8"?>
152 <manifest:manifest xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
153 <manifest:file-entry manifest:media-type="application/vnd.oasis.opendocument.spreadsheet" manifest:full-path="/"/>
154 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/statusbar/"/>
155 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/accelerator/"/>
156 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/floater/"/>
157 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/popupmenu/"/>
158 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/progressbar/"/>
159 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/menubar/"/>
160 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/toolbar/"/>
161 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/images/Bitmaps/"/>
162 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/images/"/>
163 <manifest:file-entry manifest:media-type="application/vnd.sun.xml.ui.configuration" manifest:full-path="Configurations2/"/>
164 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="content.xml"/>
165 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="styles.xml"/>
166 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="meta.xml"/>
167 <manifest:file-entry manifest:media-type="" manifest:full-path="Thumbnails/"/>
168 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="settings.xml"/>
169 </manifest:manifest>';
174 C4::ImportExportFramework - Import/Export Framework to Excel-xml/ODS Module Functions
178 use C4::ImportExportFramework;
182 Module to Import/Export Framework to Excel-xml/ODS on intranet administration - MARC Frameworks section
184 Module to Import/Export Framework to Excel-xml/ODS on intranet administration - MARC Frameworks section
185 exporting the tables marc_tag_structure, marc_subfield_structure to excel-xml/ods or viceversa
187 Functions for handling import/export.
194 =head2 ExportFramework
196 Export all the information of a MARC or Authority Type Framework to an excel "xml" file, comma separated values "csv" file or OpenDocument SpreadSheet "ods" file.
205 my ($frameworkcode, $xmlStrRef, $mode, $frameworktype) = @_;
207 my $dbh = C4::Context->dbh;
212 if ($mode eq 'ods' || $mode eq 'excel') {
214 my $parser = XML::LibXML->new();
215 $dom = $parser->parse_string(($mode && $mode eq 'ods')?ODSSTR:XMLSTR);
217 $root = $dom->documentElement();
218 if ($mode && $mode eq 'ods') {
219 my $elementBody = $dom->createElement('office:body');
220 $root->appendChild($elementBody);
221 $elementSS = $dom->createElement('office:spreadsheet');
222 $elementBody->appendChild($elementSS);
227 Koha::Logger->get->warn("Error ExportFramework $@");
232 my $table = 'marc_tag_structure';
233 my $subtable = 'marc_subfield_structure';
234 if ($frameworktype eq "authority") {
235 $table = 'auth_tag_structure';
236 $subtable = 'auth_subfield_structure';
239 if (_export_table($table, $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode, $frameworktype)) {
240 if (_export_table($subtable, $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode, $frameworktype)) {
241 $$xmlStrRef = $dom->toString(1) if ($mode eq 'ods' || $mode eq 'excel');
252 # Export all the data from a mysql table to an spreadsheet.
255 my ($table, $dbh, $dom, $root, $frameworkcode, $mode, $frameworktype) = @_;
256 if ($mode eq 'csv') {
257 _export_table_csv($table, $dbh, $dom, $root, $frameworkcode, $frameworktype);
258 } elsif ($mode eq 'ods') {
259 _export_table_ods($table, $dbh, $dom, $root, $frameworkcode, $frameworktype);
261 _export_table_excel($table, $dbh, $dom, $root, $frameworkcode, $frameworktype);
265 # Export the mysql table to an csv file
266 sub _export_table_csv
268 my ($table, $dbh, $strCSV, $root, $frameworkcode, $frameworktype) = @_;
271 # First row with the name of the columns
272 my $query = 'SHOW COLUMNS FROM ' . $table;
273 my $sth = $dbh->prepare($query);
276 while (my $hashRef = $sth->fetchrow_hashref) {
277 $$strCSV .= '"' . $hashRef->{Field} . '",';
278 push @fields, $hashRef->{Field};
282 # Populate rows with the data from mysql
283 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
284 if ($frameworktype eq "authority") {
285 $query = 'SELECT * FROM ' . $table . ' WHERE authtypecode=?';
287 $sth = $dbh->prepare($query);
288 $sth->execute($frameworkcode);
290 while (my $hashRef = $sth->fetchrow_hashref) {
291 for my $field (@fields) {
292 my $value = $hashRef->{$field} // q||;
293 $value =~ s/[\r\n]//g;
294 $$strCSV .= '"' . $value . '",';
301 # Separator for change of table
302 $$strCSV .= '"#-#",';
309 Koha::Logger->get->warn("Error _export_table_csv $@");
316 # Export the mysql table to an ods file
317 sub _export_table_ods
319 my ($table, $dbh, $dom, $root, $frameworkcode, $frameworktype) = @_;
322 my $elementTable = $dom->createElement('table:table');
323 $elementTable->setAttribute('table:name', $table);
324 $elementTable->setAttribute('table:print', 'false');
325 $root->appendChild($elementTable);
326 my $elementRow = $dom->createElement('table:table-row');
327 $elementTable->appendChild($elementRow);
331 # First row with the name of the columns
332 my $query = 'SHOW COLUMNS FROM ' . $table;
333 my $sth = $dbh->prepare($query);
336 while (my $hashRef = $sth->fetchrow_hashref) {
337 $elementCell = $dom->createElement('table:table-cell');
338 $elementCell->setAttribute('office:value-type', 'string');
339 $elementCell->setAttribute('office:value', $hashRef->{Field});
340 $elementRow->appendChild($elementCell);
341 $elementData = $dom->createElement('text:p');
342 $elementCell->appendChild($elementData);
343 $elementData->appendTextNode($hashRef->{Field});
344 push @fields, {name => $hashRef->{Field}, type => ($hashRef->{Type} =~ /int/i)?'float':'string'};
346 # Populate rows with the data from mysql
347 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
348 if ($frameworktype eq "authority") {
349 $query = 'SELECT * FROM ' . $table . ' WHERE authtypecode=?';
351 $sth = $dbh->prepare($query);
352 $sth->execute($frameworkcode);
354 while (my $hashRef = $sth->fetchrow_hashref) {
355 $elementRow = $dom->createElement('table:table-row');
356 $elementTable->appendChild($elementRow);
358 $data = $hashRef->{$_->{name}};
359 if ($_->{type} eq 'float' && !defined($data)) {
361 } elsif ($_->{type} eq 'string' && !defined($data)) {
363 } elsif ($_->{type} eq 'string' && (!$data && $data ne '0')) {
366 $data = _parseContent2Xml($data) if ($_->{type} eq 'string');
367 $elementCell = $dom->createElement('table:table-cell');
368 $elementCell->setAttribute('office:value-type', $_->{type});
369 $elementCell->setAttribute('office:value', $data);
370 $elementRow->appendChild($elementCell);
371 $elementData = $dom->createElement('text:p');
372 $elementCell->appendChild($elementData);
373 $elementData->appendTextNode($data);
378 Koha::Logger->get->warn("Error _export_table_ods $@");
385 # Export the mysql table to an excel-xml (openoffice/libreoffice compatible) file
386 sub _export_table_excel
388 my ($table, $dbh, $dom, $root, $frameworkcode, $frameworktype) = @_;
391 my $elementWS = $dom->createElement('Worksheet');
392 $elementWS->setAttribute('ss:Name', $table);
393 $root->appendChild($elementWS);
394 my $elementTable = $dom->createElement('ss:Table');
395 $elementWS->appendChild($elementTable);
396 my $elementRow = $dom->createElement('ss:Row');
397 $elementTable->appendChild($elementRow);
399 # First row with the name of the columns
402 my $query = 'SHOW COLUMNS FROM ' . $table;
403 my $sth = $dbh->prepare($query);
406 while (my $hashRef = $sth->fetchrow_hashref) {
407 $elementCell = $dom->createElement('ss:Cell');
408 $elementCell->setAttribute('ss:StyleID', 's27');
409 $elementRow->appendChild($elementCell);
410 $elementData = $dom->createElement('ss:Data');
411 $elementData->setAttribute('ss:Type', 'String');
412 $elementCell->appendChild($elementData);
413 $elementData->appendTextNode($hashRef->{Field});
414 push @fields, {name => $hashRef->{Field}, type => ($hashRef->{Type} =~ /int/i)?'Number':'String'};
416 # Populate rows with the data from mysql
417 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
418 if ($frameworktype eq "authority") {
419 $query = 'SELECT * FROM ' . $table . ' WHERE authtypecode=?';
421 $sth = $dbh->prepare($query);
422 $sth->execute($frameworkcode);
424 while (my $hashRef = $sth->fetchrow_hashref) {
425 $elementRow = $dom->createElement('ss:Row');
426 $elementTable->appendChild($elementRow);
428 $elementCell = $dom->createElement('ss:Cell');
429 $elementRow->appendChild($elementCell);
430 $elementData = $dom->createElement('ss:Data');
431 $elementData->setAttribute('ss:Type', $_->{type});
432 $elementCell->appendChild($elementData);
433 $data = $hashRef->{$_->{name}};
434 if ($_->{type} eq 'Number' && !defined($data)) {
436 } elsif ($_->{type} eq 'String' && !defined($data)) {
438 } elsif ($_->{type} eq 'String' && (!$data && $data ne '0')) {
441 $elementData->appendTextNode(($_->{type} eq 'String')?_parseContent2Xml($data):$data);
446 Koha::Logger->get->warn("Error _export_table_excel $@");
450 }#_export_table_excel
452 # Format chars problematics to a correct format for xml.
453 sub _parseContent2Xml
457 $content =~ s/\&(?![a-zA-Z#0-9]{1,4};)/&/g;
458 $content =~ s/</</g;
459 $content =~ s/>/>/g;
464 # Get the tmp directory on the system
468 if ($ENV{'TMP'} && -d $ENV{'TMP'}) {
470 } elsif ($ENV{'TMPDIR'} && -d $ENV{'TMPDIR'}) {
471 $tmp = $ENV{'TMPDIR'};
472 } elsif ($ENV{'TEMP'} && -d $ENV{'TEMP'}) {
479 # Create our tempdir directory for the ods process
484 my $tempdir = (-d $tmp)?$tmp . '/':'./';
485 $tempdir .= 'tmp_ods_' . Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
498 Creates a temporary directory to create the ods file and read it to store its content in a string.
507 my ($strContent, $lang, $strODSRef) = @_;
514 import File::Temp qw/ tempfile tempdir /;
515 $tempdir = tempdir ( 'tmp_ods_' . $$ . '_XXXXXXXX', DIR => (-d $tmp)?$tmp:'.', CLEANUP => 1);
519 $tempdir = _createTmpDir($tmp);
523 # populate tempdir directory with the ods elements
525 if (open($fh, '>', "$tempdir/content.xml")) {
526 print {$fh} $strContent;
529 if (open($fh, '>', "$tempdir/mimetype")) {
530 print {$fh} 'application/vnd.oasis.opendocument.spreadsheet';
533 if (open($fh, '>', "$tempdir/meta.xml")) {
534 print {$fh} _getMeta($lang);
537 if (open($fh, '>', "$tempdir/styles.xml")) {
538 print {$fh} ODS_STYLES_STR;
541 if (open($fh, '>', "$tempdir/settings.xml")) {
542 print {$fh} ODS_SETTINGS_STR;
545 mkdir($tempdir.'/META-INF/');
546 mkdir($tempdir.'/Configurations2/');
547 mkdir($tempdir.'/Configurations2/acceleator/');
548 mkdir($tempdir.'/Configurations2/images/');
549 mkdir($tempdir.'/Configurations2/popupmenu/');
550 mkdir($tempdir.'/Configurations2/statusbar/');
551 mkdir($tempdir.'/Configurations2/floater/');
552 mkdir($tempdir.'/Configurations2/menubar/');
553 mkdir($tempdir.'/Configurations2/progressbar/');
554 mkdir($tempdir.'/Configurations2/toolbar/');
556 if (open($fh, '>', "$tempdir/META-INF/manifest.xml")) {
557 print {$fh} ODS_MANIFEST_STR;
562 Koha::Logger->get->warn("Error createODS $@");
564 # create ods file from tempdir directory
566 require Archive::Zip;
567 import Archive::Zip qw( :ERROR_CODES :CONSTANTS );
568 my $zip = Archive::Zip->new();
569 $zip->addTree( $tempdir, '' );
570 $zip->writeToFileNamed($tempdir . '/new.ods');
573 my $cmd = qx(which zip 2>/dev/null || whereis zip);
575 $cmd = 'zip' if (!$cmd || !-x $cmd);
576 system("cd $tempdir && $cmd -r new.ods ./");
579 # read ods file and return as a string
580 if (-f "$tempdir/new.ods") {
581 if (open ($fh, '<', "$tempdir/new.ods")) {
584 while (read ($fh, $buffer, 65536)) {
585 $$strODSRef .= $buffer;
591 # delete tempdir directory
592 if (!$tempModule && $tempdir) {
595 import File::Temp qw/ rmtree /;
599 system("rm -rf $tempdir");
609 # return Meta content for ods file
614 my $myDate = strftime ("%Y-%m-%dT%H:%M:%S", localtime(time()));
615 my $meta = '<?xml version="1.0" encoding="UTF-8"?>
616 <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">
618 <meta:generator>ods-php</meta:generator>
619 <meta:creation-date>' . $myDate . '</meta:creation-date>
620 <dc:date>' . $myDate . '</dc:date>
621 <dc:language>' . $lang . '</dc:language>
622 <meta:editing-cycles>2</meta:editing-cycles>
623 <meta:editing-duration>PT15S</meta:editing-duration>
624 <meta:user-defined meta:name="Info 1"/>
625 <meta:user-defined meta:name="Info 2"/>
626 <meta:user-defined meta:name="Info 3"/>
627 <meta:user-defined meta:name="Info 4"/>
629 </office:document-meta>';
634 =head2 ImportFramework
636 Import all the information of a MARC or Authority Type Framework from a excel-xml/ods file.
645 my ($filename, $frameworkcode, $deleteFilename, $frameworktype) = @_;
649 my $dbh = C4::Context->dbh;
650 if (-r $filename && $dbh) {
652 if ($filename =~ /\.(csv|ods|xml)$/i) {
655 unlink ($filename) if ($deleteFilename); # remove temporary file
658 if ($extension eq 'ods') {
659 ($tempdir, $filename) = _openODS($filename, $deleteFilename);
664 if ($extension eq 'ods' || $extension eq 'xml') {
665 # They have xml structure, so read it on a dom object
666 my $parser = XML::LibXML->new();
667 $dom = $parser->parse_file($filename);
669 my $root = $dom->documentElement();
672 # They are text files, so open it to read
673 open($dom, '<', $filename);
676 my $table = 'marc_tag_structure';
677 my $subtable = 'marc_subfield_structure';
678 if ($frameworktype eq "authority") {
679 $table = 'auth_tag_structure';
680 $subtable = 'auth_subfield_structure';
684 # Process both tables
686 my $numDeletedAux = 0;
687 if (($numDeletedAux = _import_table($dbh, $table, $frameworkcode, $dom, ['frameworkcode', 'tagfield'], $extension, $frameworktype)) >= 0) {
688 $numDeleted += $numDeletedAux if ($numDeletedAux > 0);
689 if (($numDeletedAux = _import_table($dbh, $subtable, $frameworkcode, $dom, ['frameworkcode', 'tagfield', 'tagsubfield'], $extension, $frameworktype)) >= 0) {
690 $numDeleted += $numDeletedAux if ($numDeletedAux > 0);
691 $ok = ($numDeleted > 0)?$numDeleted:0;
695 Koha::Logger->get->warn("Error ImportFramework couldn't create dom");
699 Koha::Logger->get->warn("Error ImportFramework $@");
701 if ($extension eq 'csv') {
702 close($dom) if ($dom);
706 unlink ($filename) if ($deleteFilename); # remove temporary file
708 Koha::Logger->get->warn("Error ImportFramework no conex to database or not readeable $filename");
710 if ($deleteFilename && $tempdir && -d $tempdir && -w $tempdir) {
713 import File::Temp qw/ rmtree /;
717 system("rm -rf $tempdir");
723 # Open (uncompress) ods file and return the content.xml file
726 my ($filename, $deleteFilename) = @_;
733 import File::Temp qw/ tempfile tempdir /;
734 $tempdir = tempdir ( 'tmp_ods_' . $$ . '_XXXXXXXX', DIR => (-d $tmp)?$tmp:'.', CLEANUP => 1);
738 $tempdir = _createTmpDir($tmp);
742 require Archive::Zip;
743 import Archive::Zip qw( :ERROR_CODES :CONSTANTS );
744 my $zip = Archive::Zip->new($filename);
745 foreach my $file ($zip->members) {
746 next if ($file->isDirectory);
747 (my $extractName = $file->fileName) =~ s{.*/}{};
748 next unless ($extractName eq 'content.xml');
749 $file->extractToFileNamed("$tempdir/$extractName");
753 my $cmd = qx(which unzip 2>/dev/null || whereis unzip);
755 $cmd = 'unzip' if (!$cmd || !-x $cmd);
756 system("$cmd $filename -d $tempdir");
758 if (-f "$tempdir/content.xml") {
759 unlink ($filename) if ($deleteFilename);
760 return ($tempdir, "$tempdir/content.xml");
763 unlink ($filename) if ($deleteFilename);
764 return ($tempdir, undef);
769 # Check the table and columns corresponds with worksheet
770 sub _check_validity_worksheet
772 my ($dbh, $table, $nodeFields, $fieldsA, $format) = @_;
776 my $query = 'DESCRIBE ' . $table;
777 my $sth = $dbh->prepare($query);
780 $query = 'SHOW COLUMNS FROM ' . $table;
781 $sth = $dbh->prepare($query);
784 while (my $hashRef = $sth->fetchrow_hashref) {
785 $fields->{$hashRef->{Field}} = $hashRef->{Field};
793 _getFields($nodeFields, $fieldsR, $format);
797 unless (exists($fields->{$_})) {
804 }#_check_validity_worksheet
807 # Import the data from an excel-xml/ods to mysql tables.
810 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $format, $frameworktype) = @_;
814 # Create hash with all elements defined by primary key to know which ones to delete after parsing the spreadsheet
818 $query = 'SELECT ' . join(',', @fields) . ' FROM ' . $table . ' WHERE frameworkcode=?';
819 if ($frameworktype eq "authority") {
820 $query = 'SELECT ' . join(',', @fields) . ' FROM ' . $table . ' WHERE authtypecode=?';
822 my $sth = $dbh->prepare($query);
823 $sth->execute($frameworkcode);
825 while (my $hashRef = $sth->fetchrow_hashref) {
827 map { $field .= $hashRef->{$_} . '_'; } @fields;
829 $fields2Delete{$field} = 1;
834 if ($format eq 'csv') {
837 my $query = 'SHOW COLUMNS FROM ' . $table;
838 my $sth = $dbh->prepare($query);
840 while (my $hashRef = $sth->fetchrow_hashref) {
841 push @fieldsName, $hashRef->{Field};
844 $ok = _import_table_csv($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete, \@fieldsName);
845 } elsif ($format eq 'ods') {
846 $ok = _import_table_ods($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete);
848 $ok = _import_table_excel($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete);
851 if (($ok = scalar(keys %fields2Delete)) > 0) {
852 $query = 'DELETE FROM ' . $table . ' WHERE ';
853 map {$query .= $_ . '=? AND ';} @$PKArray;
854 $query = substr($query, 0, -4);
855 my $sth = $dbh->prepare($query);
856 for (keys %fields2Delete) {
858 $sth->execute(($frameworkcode, split('_', $_)));
869 # Insert/Update the row from the spreadsheet in the database
872 my ($dbh, $table, $fields, $dataStr, $updateStr, $dataFields, $dataFieldsHash, $PKArray, $fieldsPK, $fields2Delete) = @_;
876 $query = 'INSERT INTO ' . $table . ' (' . $fields . ') VALUES (' . $dataStr . ') ON DUPLICATE KEY UPDATE ' . $updateStr;
878 my $sth = $dbh->prepare($query);
879 $sth->execute((@$dataFields, @$dataFields));
882 Koha::Logger->get->warn("Error _processRow_DB $@");
888 map { $field .= $dataFieldsHash->{$_} . '_'; } @$fieldsPK;
890 delete $fields2Delete->{$field} if (exists($fields2Delete->{$field}));
896 # Process the rows of a worksheet and insert/update them in a mysql table.
897 sub _processRows_Table
899 my ($dbh, $frameworkcode, $nodeR, $table, $PKArray, $format, $fields2Delete) = @_;
908 my @fieldsPK = @$PKArray;
911 if ($nodeR->nodeType == 1 && (($format && $format eq 'ods' && $nodeR->nodeName =~ /(?:table:)?table-row/) || ($nodeR->nodeName =~ /(?:ss:)?Row/)) && $nodeR->hasChildNodes()) {
914 _getFields($nodeR, \@fields, $format);
915 return 0 unless _check_validity_worksheet($dbh, $table, $nodeR, \@fields, $format);
916 $fields = join(',', @fields);
918 map { $dataStr .= '?,';} @fields;
919 chop($dataStr) if ($dataStr);
921 map { $updateStr .= $_ . '=?,';} @fields;
922 chop($updateStr) if ($updateStr);
925 my ($dataFields, $dataFieldsR) = _getDataFields($frameworkcode, $nodeR, \@fields, $format);
926 if (scalar(@fields) == scalar(@$dataFieldsR)) {
927 $ok = _processRow_DB($dbh, $table, $fields, $dataStr, $updateStr, $dataFieldsR, $dataFields, $PKArray, \@fieldsPK, $fields2Delete);
929 warn "$j don't match number of fields " . scalar(@fields) . ' vs ' . scalar(@$dataFieldsR) . "($dataStr)";
934 $nodeR = $nodeR->nextSibling;
942 # Import worksheet from the csv file to the mysql table
943 sub _import_table_csv
945 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete, $fields) = @_;
949 my $numFields = @$fields;
950 my $fieldsNameRead = 0;
952 my ($fieldsStr, $dataStr, $updateStr, @empty_indexes);
953 my @fieldsPK = @$PKArray;
957 my $csv = Text::CSV_XS->new ({ binary => 1 });
958 while ( my $row = $csv->getline($dom) ) {
961 next if scalar @arrData == grep { $_ eq '' } @arrData; # Emtpy lines
962 #$arrData[0] = substr($arrData[0], 1) if ($arrData[0] =~ /^"/);
963 #$arrData[$#arrData] =~ s/[\r\n]+$//;
964 #chop $arrData[$#arrData] if ($arrData[$#arrData] =~ /"$/);
966 if ($arrData[0] eq '#-#' && $arrData[$#arrData] eq '#-#') {
967 # Change of table with separators #-#
969 } elsif ($fieldsNameRead && $arrData[0] eq 'tagfield') {
970 # Change of table because we begin with field name with former field names read
974 if (!$fieldsNameRead) {
975 # New table, we read the field names
977 $fields = [@arrData];
978 my $non_empty_fields = [ grep { $_ ne '' } @$fields ];
979 @empty_indexes = indexes { $_ eq '' } @$fields;
980 $fieldsStr = join(',', @$non_empty_fields);
982 map { $dataStr .= '?,';} @$non_empty_fields;
983 chop($dataStr) if ($dataStr);
985 map { $updateStr .= $_ . '=?,';} @$non_empty_fields;
986 chop($updateStr) if ($updateStr);
992 for my $value (@arrData) {
993 if ( grep { $_ == $j } @empty_indexes ) {
995 } elsif ($fields->[$j] eq 'frameworkcode' && $value ne $frameworkcode) {
996 $dataFields{$fields->[$j]} = $frameworkcode;
997 push @values, $frameworkcode;
998 } elsif ($fields->[$j] eq 'isurl' && defined $value && $value eq q{}) {
999 $dataFields{$fields->[$j]} = undef;
1000 push @values, undef;
1002 $dataFields{$fields->[$j]} = $value;
1003 push @values, $value;
1007 $ok = _processRow_DB($dbh, $table, $fieldsStr, $dataStr, $updateStr, \@values, \%dataFields, $PKArray, \@fieldsPK, $fields2Delete);
1017 # Import worksheet from the ods content.xml file to the mysql table
1018 sub _import_table_ods
1020 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete) = @_;
1022 my $xc = XML::LibXML::XPathContext->new($dom);
1023 $xc->registerNs('xmlns:office','urn:oasis:names:tc:opendocument:xmlns:office:1.0');
1024 $xc->registerNs('xmlns:table','urn:oasis:names:tc:opendocument:xmlns:table:1.0');
1025 $xc->registerNs('xmlns:text','urn:oasis:names:tc:opendocument:xmlns:text:1.0');
1027 @nodes = $xc->findnodes('//table:table[@table:name="' . $table . '"]');
1028 if (@nodes == 1 && $nodes[0]->hasChildNodes()) {
1029 my $nodeR = $nodes[0]->firstChild;
1030 return _processRows_Table($dbh, $frameworkcode, $nodeR, $table, $PKArray, 'ods', $fields2Delete);
1032 Koha::Logger->get->warn("Error _import_table_ods there's not worksheet for $table");
1038 # Import worksheet from the excel-xml file to the mysql table
1039 sub _import_table_excel
1041 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete) = @_;
1043 my $xc = XML::LibXML::XPathContext->new($dom);
1044 $xc->registerNs('xmlns','urn:schemas-microsoft-com:office:spreadsheet');
1045 $xc->registerNs('xmlns:ss','urn:schemas-microsoft-com:office:spreadsheet');
1046 $xc->registerNs('xmlns:x','urn:schemas-microsoft-com:office:excel');
1048 @nodes = $xc->findnodes('//ss:Worksheet[@ss:Name="' . $table . '"]');
1050 for (my $i=0; $i < @nodes; $i++) {
1051 my @nodesT = $nodes[$i]->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Table');
1052 if (@nodesT == 1 && $nodesT[0]->hasChildNodes()) {
1053 my $nodeR = $nodesT[0]->firstChild;
1054 return _processRows_Table($dbh, $frameworkcode, $nodeR, $table, $PKArray, undef, $fields2Delete);
1058 Koha::Logger->get->warn("Error _import_table_excel there's not worksheet for $table");
1061 }#_import_table_excel
1064 # Get the data from a cell on a ods file through the value attribute or the text node
1071 if ($node->nodeType == 1 && $node->nodeName =~ /(?:table:)?table-cell/) {
1072 if ($node->hasAttributeNS('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'value')) {
1073 $data = $node->getAttributeNS('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'value');
1074 } elsif ($node->hasChildNodes()) {
1075 my @nodes2 = $node->getElementsByTagNameNS('urn:oasis:names:tc:opendocument:xmlns:text:1.0', 'p');
1076 if (@nodes2 == 1 && $nodes2[0]->hasChildNodes()) {
1077 $data = $nodes2[0]->firstChild->nodeValue;
1080 if ($node->hasAttributeNS('urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'number-columns-repeated')) {
1081 $repeated = $node->getAttributeNS('urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'number-columns-repeated');
1084 return ($data, $repeated);
1088 # Get the data from a row of a spreadsheet
1091 my ($frameworkcode, $node, $fields, $format) = @_;
1093 my $dataFields = {};
1094 my @dataFieldsA = ();
1095 if ($node && $node->hasChildNodes()) {
1096 my $node2 = $node->firstChild;
1097 my ($data, $repeated);
1102 if ($format && $format eq 'ods') {
1103 ($data, $repeated) = _getDataNodeODS($node2) if ($repeated <= 0);
1107 if ($node2->nodeType == 1 && $node2->nodeName =~ /(?:ss:)?Cell/) {
1108 my @nodes3 = $node2->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Data');
1109 if (@nodes3 == 1 && $nodes3[0]->hasChildNodes()) {
1110 $data = $nodes3[0]->firstChild->nodeValue;
1117 $data = '' if ($data eq '#');
1118 if ( $fields->[$i] eq 'frameworkcode' ) {
1119 $data = $frameworkcode;
1121 elsif ( $fields->[$i] eq 'isurl' ) {
1122 $data = undef if defined $data && $data eq q{};
1124 $dataFields->{$fields->[$i]} = $data;
1125 push @dataFieldsA, $data;
1129 $node2 = $node2->nextSibling if ($repeated <= 0);
1132 return ($dataFields, \@dataFieldsA);
1136 # Get the data from the first row to know the column names
1139 my ($node, $fields, $format) = @_;
1141 if ($node && $node->hasChildNodes()) {
1142 my $node2 = $node->firstChild;
1143 my ($data, $repeated);
1145 if ($format && $format eq 'ods') {
1146 ($data, $repeated) = _getDataNodeODS($node2);
1147 push @$fields, $data if (defined($data));
1149 if ($node2->nodeType == 1 && $node2->nodeName =~ /(?:ss:)?Cell/) {
1150 my @nodes3 = $node2->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Data');
1151 if (@nodes3 == 1 && $nodes3[0]->hasChildNodes()) {
1152 $data = $nodes3[0]->firstChild->nodeValue;
1153 push @$fields, $data;
1157 $node2 = $node2->nextSibling;
1170 Koha Development Team <http://koha-community.org/>