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 under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 use XML::LibXML::XPathContext;
24 use Digest::MD5 qw(md5_base64);
25 use POSIX qw(strftime);
31 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
34 $VERSION = 3.03; # 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' || $mode eq 'sql')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode)) {
234 if (_export_table('marc_subfield_structure', $dbh, ($mode eq 'csv' || $mode eq 'sql')?$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 'sql') {
253 _export_table_sql($table, $dbh, $dom, $root, $frameworkcode);
254 } elsif ($mode eq 'ods') {
255 _export_table_ods($table, $dbh, $dom, $root, $frameworkcode);
257 _export_table_excel($table, $dbh, $dom, $root, $frameworkcode);
262 # Export the mysql table to an sql file
263 sub _export_table_sql
265 my ($table, $dbh, $strSQL, $root, $frameworkcode) = @_;
268 # First row with the name of the columns
269 my $query = 'SHOW COLUMNS FROM ' . $table;
270 my $sth = $dbh->prepare($query);
273 while (my $hashRef = $sth->fetchrow_hashref) {
274 push @fields, $hashRef->{Field};
276 my $fields = join(',', @fields);
277 $$strSQL .= 'DELETE FROM ' . $table . ' WHERE frameworkcode=' . $dbh->quote($frameworkcode) . ';';
279 # Populate rows with the data from mysql
280 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
281 $sth = $dbh->prepare($query);
282 $sth->execute($frameworkcode);
283 while (my $hashRef = $sth->fetchrow_hashref) {
284 $$strSQL .= 'INSERT INTO ' . $table . ' (' . $fields . ') VALUES (';
286 $$strSQL .= $dbh->quote($hashRef->{$_}) . ',';
289 $$strSQL .= ');' . chr(10);
291 $$strSQL .= chr(10) . chr(10);
294 $debug and warn "Error _export_table_sql $@\n";
301 # Export the mysql table to an csv file
302 sub _export_table_csv
304 my ($table, $dbh, $strCSV, $root, $frameworkcode) = @_;
307 # First row with the name of the columns
308 my $query = 'SHOW COLUMNS FROM ' . $table;
309 my $sth = $dbh->prepare($query);
312 while (my $hashRef = $sth->fetchrow_hashref) {
313 $$strCSV .= '"' . $hashRef->{Field} . '",';
314 push @fields, $hashRef->{Field};
318 # Populate rows with the data from mysql
319 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
320 $sth = $dbh->prepare($query);
321 $sth->execute($frameworkcode);
323 while (my $hashRef = $sth->fetchrow_hashref) {
325 $hashRef->{$_} =~ s/[\r\n]//g;
326 $$strCSV .= '"' . $hashRef->{$_} . '",';
333 # Separator for change of table
334 $$strCSV .= '"#-#",';
341 $debug and warn "Error _export_table_csv $@\n";
348 # Export the mysql table to an ods file
349 sub _export_table_ods
351 my ($table, $dbh, $dom, $root, $frameworkcode) = @_;
354 my $elementTable = $dom->createElement('table:table');
355 $elementTable->setAttribute('table:name', $table);
356 $elementTable->setAttribute('table:print', 'false');
357 $root->appendChild($elementTable);
358 my $elementRow = $dom->createElement('table:table-row');
359 $elementTable->appendChild($elementRow);
363 # First row with the name of the columns
364 my $query = 'SHOW COLUMNS FROM ' . $table;
365 my $sth = $dbh->prepare($query);
368 while (my $hashRef = $sth->fetchrow_hashref) {
369 $elementCell = $dom->createElement('table:table-cell');
370 $elementCell->setAttribute('office:value-type', 'string');
371 $elementCell->setAttribute('office:value', $hashRef->{Field});
372 $elementRow->appendChild($elementCell);
373 $elementData = $dom->createElement('text:p');
374 $elementCell->appendChild($elementData);
375 $elementData->appendTextNode($hashRef->{Field});
376 push @fields, {name => $hashRef->{Field}, type => ($hashRef->{Type} =~ /int/i)?'float':'string'};
378 # Populate rows with the data from mysql
379 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
380 $sth = $dbh->prepare($query);
381 $sth->execute($frameworkcode);
383 while (my $hashRef = $sth->fetchrow_hashref) {
384 $elementRow = $dom->createElement('table:table-row');
385 $elementTable->appendChild($elementRow);
387 $data = $hashRef->{$_->{name}};
388 if ($_->{type} eq 'float' && !defined($data)) {
390 } elsif ($_->{type} eq 'string' && (!$data && $data ne '0')) {
393 $data = _parseContent2Xml($data) if ($_->{type} eq 'string');
394 $elementCell = $dom->createElement('table:table-cell');
395 $elementCell->setAttribute('office:value-type', $_->{type});
396 $elementCell->setAttribute('office:value', $data);
397 $elementRow->appendChild($elementCell);
398 $elementData = $dom->createElement('text:p');
399 $elementCell->appendChild($elementData);
400 $elementData->appendTextNode($data);
405 $debug and warn "Error _export_table_ods $@\n";
412 # Export the mysql table to an excel-xml (openoffice/libreoffice compatible) file
413 sub _export_table_excel
415 my ($table, $dbh, $dom, $root, $frameworkcode) = @_;
418 my $elementWS = $dom->createElement('Worksheet');
419 $elementWS->setAttribute('ss:Name', $table);
420 $root->appendChild($elementWS);
421 my $elementTable = $dom->createElement('ss:Table');
422 $elementWS->appendChild($elementTable);
423 my $elementRow = $dom->createElement('ss:Row');
424 $elementTable->appendChild($elementRow);
426 # First row with the name of the columns
429 my $query = 'SHOW COLUMNS FROM ' . $table;
430 my $sth = $dbh->prepare($query);
433 while (my $hashRef = $sth->fetchrow_hashref) {
434 $elementCell = $dom->createElement('ss:Cell');
435 $elementCell->setAttribute('ss:StyleID', 's27');
436 $elementRow->appendChild($elementCell);
437 $elementData = $dom->createElement('ss:Data');
438 $elementData->setAttribute('ss:Type', 'String');
439 $elementCell->appendChild($elementData);
440 $elementData->appendTextNode($hashRef->{Field});
441 push @fields, {name => $hashRef->{Field}, type => ($hashRef->{Type} =~ /int/i)?'Number':'String'};
443 # Populate rows with the data from mysql
444 $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?';
445 $sth = $dbh->prepare($query);
446 $sth->execute($frameworkcode);
448 while (my $hashRef = $sth->fetchrow_hashref) {
449 $elementRow = $dom->createElement('ss:Row');
450 $elementTable->appendChild($elementRow);
452 $elementCell = $dom->createElement('ss:Cell');
453 $elementRow->appendChild($elementCell);
454 $elementData = $dom->createElement('ss:Data');
455 $elementData->setAttribute('ss:Type', $_->{type});
456 $elementCell->appendChild($elementData);
457 $data = $hashRef->{$_->{name}};
458 if ($_->{type} eq 'Number' && !defined($data)) {
460 } elsif ($_->{type} eq 'String' && (!$data && $data ne '0')) {
463 $elementData->appendTextNode(($_->{type} eq 'String')?_parseContent2Xml($data):$data);
468 $debug and warn "Error _export_table_excel $@\n";
472 }#_export_table_excel
480 # Format chars problematics to a correct format for xml.
481 sub _parseContent2Xml
485 $content =~ s/\&(?![a-zA-Z#0-9]{1,4};)/&/g;
486 $content =~ s/</</g;
487 $content =~ s/>/>/g;
492 # Get the tmp directory on the system
496 if ($ENV{'TMP'} && -d $ENV{'TMP'}) {
498 } elsif ($ENV{'TMPDIR'} && -d $ENV{'TMPDIR'}) {
499 $tmp = $ENV{'TMPDIR'};
500 } elsif ($ENV{'TEMP'} && -d $ENV{'TEMP'}) {
507 # Create our tempdir directory for the ods process
512 my $tempdir = (-d $tmp)?$tmp . '/':'./';
513 $tempdir .= 'tmp_ods_' . Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
526 Creates a temporary directory to create the ods file and read it to store its content in a string.
535 my ($strContent, $lang, $strODSRef) = @_;
542 import File::Temp qw/ tempfile tempdir /;
543 $tempdir = tempdir ( 'tmp_ods_' . $$ . '_XXXXXXXX', DIR => (-d $tmp)?$tmp:'.', CLEANUP => 1);
547 $tempdir = _createTmpDir($tmp);
550 # populate tempdir directory with the ods elements
552 if (open(OUT, "> $tempdir/content.xml")) {
553 print OUT $strContent;
556 if (open(OUT, "> $tempdir/mimetype")) {
557 print OUT 'application/vnd.oasis.opendocument.spreadsheet';
560 if (open(OUT, "> $tempdir/meta.xml")) {
561 print OUT _getMeta($lang);
564 if (open(OUT, "> $tempdir/styles.xml")) {
565 print OUT ODS_STYLES_STR;
568 if (open(OUT, "> $tempdir/settings.xml")) {
569 print OUT ODS_SETTINGS_STR;
572 mkdir($tempdir.'/META-INF/');
573 mkdir($tempdir.'/Configurations2/');
574 mkdir($tempdir.'/Configurations2/acceleator/');
575 mkdir($tempdir.'/Configurations2/images/');
576 mkdir($tempdir.'/Configurations2/popupmenu/');
577 mkdir($tempdir.'/Configurations2/statusbar/');
578 mkdir($tempdir.'/Configurations2/floater/');
579 mkdir($tempdir.'/Configurations2/menubar/');
580 mkdir($tempdir.'/Configurations2/progressbar/');
581 mkdir($tempdir.'/Configurations2/toolbar/');
582 if (open(OUT, "> $tempdir/META-INF/manifest.xml")) {
583 print OUT ODS_MANIFEST_STR;
588 $debug and warn "Error createODS $@\n";
590 # create ods file from tempdir directory
592 require Archive::Zip;
593 import Archive::Zip qw( :ERROR_CODES :CONSTANTS );
594 my $zip = Archive::Zip->new();
595 $zip->addTree( $tempdir, '' );
596 $zip->writeToFileNamed($tempdir . '/new.ods');
599 my $cmd = qx(which zip 2>/dev/null || whereis zip);
601 $cmd = 'zip' if (!$cmd || !-x $cmd);
602 system("cd $tempdir && $cmd -r new.ods ./");
605 # read ods file and return as a string
606 if (-f "$tempdir/new.ods") {
607 if (open (MYFILE, "$tempdir/new.ods")) {
610 while (read (MYFILE, $buffer, 65536)) {
611 $$strODSRef .= $buffer;
617 # delete tempdir directory
618 if (!$tempModule && $tempdir) {
621 import File::Temp qw/ rmtree /;
625 system("rm -rf $tempdir");
635 # return Meta content for ods file
640 my $myDate = strftime ("%Y-%m-%dT%H:%M:%S", localtime(time()));
641 my $meta = '<?xml version="1.0" encoding="UTF-8"?>
642 <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">
644 <meta:generator>ods-php</meta:generator>
645 <meta:creation-date>' . $myDate . '</meta:creation-date>
646 <dc:date>' . $myDate . '</dc:date>
647 <dc:language>' . $lang . '</dc:language>
648 <meta:editing-cycles>2</meta:editing-cycles>
649 <meta:editing-duration>PT15S</meta:editing-duration>
650 <meta:user-defined meta:name="Info 1"/>
651 <meta:user-defined meta:name="Info 2"/>
652 <meta:user-defined meta:name="Info 3"/>
653 <meta:user-defined meta:name="Info 4"/>
655 </office:document-meta>';
660 =head2 ImportFramework
662 Import all the information of a Framework from a excel-xml/ods file.
671 my ($filename, $frameworkcode, $deleteFilename) = @_;
675 my $dbh = C4::Context->dbh;
676 if (-r $filename && $dbh) {
678 if ($filename =~ /\.(csv|ods|xml|sql)$/i) {
681 unlink ($filename) if ($deleteFilename); # remove temporary file
684 if ($extension eq 'ods') {
685 ($tempdir, $filename) = _openODS($filename, $deleteFilename);
690 if ($extension eq 'ods' || $extension eq 'xml') {
691 # They have xml structure, so read it on a dom object
692 my $parser = XML::LibXML->new();
693 $dom = $parser->parse_file($filename);
695 my $root = $dom->documentElement();
698 # They are text files, so open it to read
699 open($dom, '<', $filename);
702 # For sql we execute the line
703 if ($extension eq 'sql') {
704 _parseSQLLine($dbh, $dom, $frameworkcode);
707 # Process both tables
709 my $numDeletedAux = 0;
710 if (($numDeletedAux = _import_table($dbh, 'marc_tag_structure', $frameworkcode, $dom, ['frameworkcode', 'tagfield'], $extension)) >= 0) {
711 $numDeleted += $numDeletedAux if ($numDeletedAux > 0);
712 if (($numDeletedAux = _import_table($dbh, 'marc_subfield_structure', $frameworkcode, $dom, ['frameworkcode', 'tagfield', 'tagsubfield'], $extension)) >= 0) {
713 $numDeleted += $numDeletedAux if ($numDeletedAux > 0);
714 $ok = ($numDeleted > 0)?$numDeleted:0;
719 $debug and warn "Error ImportFramework couldn't create dom\n";
723 $debug and warn "Error ImportFramework $@\n";
725 if ($extension eq 'sql' || $extension eq 'csv') {
726 close($dom) if ($dom);
730 unlink ($filename) if ($deleteFilename); # remove temporary file
732 $debug and warn "Error ImportFramework no conex to database or not readeable $filename\n";
734 if ($deleteFilename && $tempdir && -d $tempdir && -w $tempdir) {
737 import File::Temp qw/ rmtree /;
741 system("rm -rf $tempdir");
748 # Parse the sql statement to see if the frameworkcode is correct
749 # We're checking only the delete and insert SQL commands generated in the export process
752 my ($dbh, $dom, $frameworkcode) = @_;
756 require SQL::Statement;
757 $parser = SQL::Parser->new('AnyData');
758 $parser->{RaiseError}=1;
759 $parser->{PrintError}=0;
761 my $literalEscape = (C4::Context->config("db_scheme") eq 'mysql')?'\\':'\'';
767 # we don't want to execute any sql statement, only the ones dealing with frameworks
768 next unless ($line =~ /^\s*(?i:DELETE\s+FROM|INSERT\s+INTO)\s+(?:marc_tag_structure|marc_subfield_structure)/);
770 # We check if the frameworkcode is the same, if not we change it
771 unless ($line =~ /'$frameworkcode'/) {
775 $line = substr($line, 0 ,-1) if ($line =~ /;$/);
776 my $stmt = SQL::Statement->new($line, $parser);
777 my $where = $stmt->where();
778 if ($where && $where->op() eq '=' && $line =~ /^\s*DELETE/) {
779 $line =~ s/frameworkcode='.*?'/frameworkcode='$frameworkcode';/ unless ($_ =~ /frameworkcode='$frameworkcode'/);
784 # Due to lacking of backward compatibility
785 if ($parser->VERSION < 1.30) {
786 $table = lc($stmt->tables(0)->name());
787 @arrFields = map{lc($_->name)} $stmt->columns;
788 @arrValues = $stmt->row_values();
790 $table = $stmt->tables(0)->name();
791 @arrValues = $stmt->row_values(0);
792 my @aux = $stmt->column_defs();
794 push @arrFields, $_->{value};
797 if (scalar(@arrFields) == scalar(@arrValues)) {
801 if ($_ eq 'frameworkcode' && $arrValues[$j] ne $frameworkcode) {
802 $arrValues[$j] = $dbh->quote($frameworkcode);
805 $arrValues[$j] = $dbh->quote($arrValues[$j]);
809 $line = 'INSERT INTO ' . $table . ' (' . join(',', @arrFields) . ') VALUES (' . join(',', @arrValues) . ');' if ($modified);
818 $line .= ';' unless ($line =~ /;$/);
819 if ($line =~ /^\s*DELETE/) {
820 $line =~ s/frameworkcode='.*?'/frameworkcode='$frameworkcode'/ unless ($_ =~ /frameworkcode='$frameworkcode'/);
821 } elsif ($line =~ /^\s*INSERT\s+INTO\s+(.*?)\s+\((.*?frameworkcode.*?)\)\s+VALUES\s+\((.+)\)\s*;\s*$/) {
825 my @arrFields = split(/\s*,\s*/, $fields);
828 _parseSQLInsertValues($values, $literalEscape, \@arrValues);
830 if (scalar(@arrFields) == scalar(@arrValues)) {
832 for (my $i=0; $i < @arrFields; $i++) {
833 if ($arrFields[$i] eq 'frameworkcode' && $arrValues[$i]->{value} ne $frameworkcode) {
834 $arrValues[$i]->{value} = $dbh->quote($frameworkcode);
836 } elsif ($arrValues[$i]->{literal}) {
837 $arrValues[$i]->{value} = $dbh->quote($arrValues[$i]->{value});
841 $line = "INSERT INTO $table ($fields) VALUES (" . join(',', map {$_->{value}} @arrValues) . ');';
854 # Simple sub to get the values from the insert sentence
855 sub _parseSQLInsertValues
857 my ($values, $literalEscape, $arrValues) = @_;
859 my ($posBegin, $posLiteral, $currentPos, $lengthValues, $currentChar);
860 $lengthValues = length($values);
862 while ($currentPos < $lengthValues) {
863 $currentChar = substr($values, $currentPos++, 1);
864 next if ($currentChar =~ /^\s$/);
865 next if ($posBegin && $currentChar !~ /^[,']$/);
867 if ($currentChar eq '\'') {
868 $posBegin = $currentPos;
869 $posLiteral = $posBegin;
871 $posBegin = $currentPos -1;
874 if ($currentChar eq ',') {
875 unless ($posLiteral) {
876 push @$arrValues, {literal => 0, value => substr($values, $posBegin, $currentPos -(1 + $posBegin))};
879 } elsif ($currentChar eq '\'' && $posLiteral) {
880 next if ($literalEscape eq '\\' && substr($values, $currentPos -2, 1) eq $literalEscape);
881 if ($literalEscape eq '\'' && substr($values, $currentPos, 1) eq $literalEscape) {
885 push @$arrValues, {literal => 1 , value => substr($values, $posBegin, $currentPos -( 1 + $posBegin))};
886 $currentPos++ if (substr($values, $currentPos, 1) eq ',');
889 } # We shouldn't get to here if the sql sentence is correct
892 push @$arrValues, {literal => ($posLiteral)?1:0, value => substr($values, $posBegin, $currentPos - $posBegin)} if ($posBegin);
893 }#_parseSQLInsertValues
896 # Open (uncompress) ods file and return the content.xml file
899 my ($filename, $deleteFilename) = @_;
906 import File::Temp qw/ tempfile tempdir /;
907 $tempdir = tempdir ( 'tmp_ods_' . $$ . '_XXXXXXXX', DIR => (-d $tmp)?$tmp:'.', CLEANUP => 1);
911 $tempdir = _createTmpDir($tmp);
915 require Archive::Zip;
916 import Archive::Zip qw( :ERROR_CODES :CONSTANTS );
917 my $zip = Archive::Zip->new($filename);
918 foreach my $file ($zip->members) {
919 next if ($file->isDirectory);
920 (my $extractName = $file->fileName) =~ s{.*/}{};
921 next unless ($extractName eq 'content.xml');
922 $file->extractToFileNamed("$tempdir/$extractName");
926 my $cmd = qx(which unzip 2>/dev/null || whereis unzip);
928 $cmd = 'unzip' if (!$cmd || !-x $cmd);
929 system("$cmd $filename -d $tempdir");
931 if (-f "$tempdir/content.xml") {
932 unlink ($filename) if ($deleteFilename);
933 return ($tempdir, "$tempdir/content.xml");
936 unlink ($filename) if ($deleteFilename);
937 return ($tempdir, undef);
942 # Check the table and columns corresponds with worksheet
943 sub _check_validity_worksheet
945 my ($dbh, $table, $nodeFields, $fieldsA, $format) = @_;
949 my $query = 'DESCRIBE ' . $table;
950 my $sth = $dbh->prepare($query);
953 $query = 'SHOW COLUMNS FROM ' . $table;
954 $sth = $dbh->prepare($query);
957 while (my $hashRef = $sth->fetchrow_hashref) {
958 $fields->{$hashRef->{Field}} = $hashRef->{Field};
966 _getFields($nodeFields, $fieldsR, $format);
970 unless (exists($fields->{$_})) {
977 }#_check_validity_worksheet
980 # Import the data from an excel-xml/ods to mysql tables.
983 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $format) = @_;
987 # Create hash with all elements defined by primary key to know which ones to delete after parsing the spreadsheet
991 $query = 'SELECT ' . join(',', @fields) . ' FROM ' . $table . ' WHERE frameworkcode=?';
992 my $sth = $dbh->prepare($query);
993 $sth->execute($frameworkcode);
995 while (my $hashRef = $sth->fetchrow_hashref) {
997 map { $field .= $hashRef->{$_} . '_'; } @fields;
999 $fields2Delete{$field} = 1;
1004 if ($format eq 'csv') {
1005 my @fieldsName = ();
1007 my $query = 'SHOW COLUMNS FROM ' . $table;
1008 my $sth = $dbh->prepare($query);
1010 while (my $hashRef = $sth->fetchrow_hashref) {
1011 push @fieldsName, $hashRef->{Field};
1014 $ok = _import_table_csv($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete, \@fieldsName);
1015 } elsif ($format eq 'ods') {
1016 $ok = _import_table_ods($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete);
1018 $ok = _import_table_excel($dbh, $table, $frameworkcode, $dom, $PKArray, \%fields2Delete);
1021 if (($ok = scalar(keys %fields2Delete)) > 0) {
1022 $query = 'DELETE FROM ' . $table . ' WHERE ';
1023 map {$query .= $_ . '=? AND ';} @$PKArray;
1024 $query = substr($query, 0, -4);
1025 my $sth = $dbh->prepare($query);
1026 for (keys %fields2Delete) {
1028 $sth->execute(($frameworkcode, split('_', $_)));
1039 # Insert/Update the row from the spreadsheet in the database
1042 my ($dbh, $db_scheme, $table, $fields, $dataStr, $updateStr, $dataFields, $dataFieldsHash, $PKArray, $fieldsPK, $fields2Delete) = @_;
1046 if ($db_scheme eq 'mysql') {
1047 $query = 'INSERT INTO ' . $table . ' (' . $fields . ') VALUES (' . $dataStr . ') ON DUPLICATE KEY UPDATE ' . $updateStr;
1049 $query = 'INSERT INTO ' . $table . ' (' . $fields . ') VALUES (' . $dataStr . ')';
1052 my $sth = $dbh->prepare($query);
1053 if ($db_scheme eq 'mysql') {
1054 $sth->execute((@$dataFields, @$dataFields));
1056 $sth->execute(@$dataFields);
1060 unless ($db_scheme eq 'mysql') {
1061 $query = 'UPDATE ' . $table . ' SET ' . $updateStr . ' WHERE ';
1062 map {$query .= $_ . '=? AND ';} @$PKArray;
1063 $query = substr($query, 0, -4);
1065 my $sth2 = $dbh->prepare($query);
1067 map {push @dataPK, $dataFieldsHash->{$_};} @$PKArray;
1068 $sth2->execute((@$dataFields, @dataPK));
1070 $ok = 1 unless ($@);
1072 $debug and warn "Error _processRows_Table $@\n";
1078 map { $field .= $dataFieldsHash->{$_} . '_'; } @$fieldsPK;
1080 delete $fields2Delete->{$field} if (exists($fields2Delete->{$field}));
1086 # Process the rows of a worksheet and insert/update them in a mysql table.
1087 sub _processRows_Table
1089 my ($dbh, $frameworkcode, $nodeR, $table, $PKArray, $format, $fields2Delete) = @_;
1097 my $db_scheme = C4::Context->config("db_scheme");
1099 my @fieldsPK = @$PKArray;
1102 if ($nodeR->nodeType == 1 && (($format && $format eq 'ods' && $nodeR->nodeName =~ /(?:table:)?table-row/) || ($nodeR->nodeName =~ /(?:ss:)?Row/)) && $nodeR->hasChildNodes()) {
1105 _getFields($nodeR, \@fields, $format);
1106 return 0 unless _check_validity_worksheet($dbh, $table, $nodeR, \@fields, $format);
1107 $fields = join(',', @fields);
1109 map { $dataStr .= '?,';} @fields;
1110 chop($dataStr) if ($dataStr);
1112 map { $updateStr .= $_ . '=?,';} @fields;
1113 chop($updateStr) if ($updateStr);
1116 my ($dataFields, $dataFieldsR) = _getDataFields($frameworkcode, $nodeR, \@fields, $format);
1117 if (scalar(@fields) == scalar(@$dataFieldsR)) {
1118 $ok = _processRow_DB($dbh, $db_scheme, $table, $fields, $dataStr, $updateStr, $dataFieldsR, $dataFields, $PKArray, \@fieldsPK, $fields2Delete);
1123 $nodeR = $nodeR->nextSibling;
1126 }#_processRows_Table
1131 # Import worksheet from the csv file to the mysql table
1132 sub _import_table_csv
1134 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete, $fields) = @_;
1137 my $partialRow = '';
1138 my $numFields = @$fields;
1139 my $fieldsNameRead = 0;
1141 my ($fieldsStr, $dataStr, $updateStr);
1142 my $db_scheme = C4::Context->config("db_scheme");
1143 my @fieldsPK = @$PKArray;
1150 # Check whether the line has an unfinished field, i.e., a field with CR/LF in its data
1151 if ($row =~ /,"[^"]*[\r\n]+$/ || $row =~ /^[^"]+[\r\n]+$/) {
1152 $row =~ s/[\r\n]+$//;
1153 $partialRow .= $row;
1157 $row = $partialRow . $row;
1160 # Line OK, process it
1161 if ($row =~ /(?:".*?",?)+/) {
1162 @arrData = split('","', $row);
1163 $arrData[0] = substr($arrData[0], 1) if ($arrData[0] =~ /^"/);
1164 $arrData[$#arrData] =~ s/[\r\n]+$//;
1165 chop $arrData[$#arrData] if ($arrData[$#arrData] =~ /"$/);
1167 if ($arrData[0] eq '#-#' && $arrData[$#arrData] eq '#-#') {
1168 # Change of table with separators #-#
1170 } elsif ($fieldsNameRead && $arrData[0] eq 'tagfield') {
1171 # Change of table because we begin with field name with former field names read
1172 seek($dom, $pos, 0);
1175 if (scalar(@$fields) == scalar(@arrData)) {
1176 if (!$fieldsNameRead) {
1177 # New table, we read the field names
1178 $fieldsNameRead = 1;
1179 for (my $i=0; $i < @arrData; $i++) {
1180 if ($arrData[$i] ne $fields->[$i]) {
1181 $fieldsNameRead = 0;
1185 if ($fieldsNameRead) {
1186 $fieldsStr = join(',', @$fields);
1188 map { $dataStr .= '?,';} @$fields;
1189 chop($dataStr) if ($dataStr);
1191 map { $updateStr .= $_ . '=?,';} @$fields;
1192 chop($updateStr) if ($updateStr);
1197 my %dataFields = ();
1199 if ($fields->[$j] eq 'frameworkcode' && $_ ne $frameworkcode) {
1200 $dataFields{$fields->[$j]} = $frameworkcode;
1201 $arrData[$j] = $frameworkcode;
1203 $dataFields{$fields->[$j]} = $_;
1207 $ok = _processRow_DB($dbh, $db_scheme, $table, $fieldsStr, $dataStr, $updateStr, \@arrData, \%dataFields, $PKArray, \@fieldsPK, $fields2Delete);
1220 # Import worksheet from the ods content.xml file to the mysql table
1221 sub _import_table_ods
1223 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete) = @_;
1225 my $xc = XML::LibXML::XPathContext->new($dom);
1226 $xc->registerNs('xmlns:office','urn:oasis:names:tc:opendocument:xmlns:office:1.0');
1227 $xc->registerNs('xmlns:table','urn:oasis:names:tc:opendocument:xmlns:table:1.0');
1228 $xc->registerNs('xmlns:text','urn:oasis:names:tc:opendocument:xmlns:text:1.0');
1230 @nodes = $xc->findnodes('//table:table[@table:name="' . $table . '"]');
1231 if (@nodes == 1 && $nodes[0]->hasChildNodes()) {
1232 my $nodeR = $nodes[0]->firstChild;
1233 return _processRows_Table($dbh, $frameworkcode, $nodeR, $table, $PKArray, 'ods', $fields2Delete);
1235 $debug and warn "Error _import_table_ods there's not worksheet for $table\n";
1241 # Import worksheet from the excel-xml file to the mysql table
1242 sub _import_table_excel
1244 my ($dbh, $table, $frameworkcode, $dom, $PKArray, $fields2Delete) = @_;
1246 my $xc = XML::LibXML::XPathContext->new($dom);
1247 $xc->registerNs('xmlns','urn:schemas-microsoft-com:office:spreadsheet');
1248 $xc->registerNs('xmlns:ss','urn:schemas-microsoft-com:office:spreadsheet');
1249 $xc->registerNs('xmlns:x','urn:schemas-microsoft-com:office:excel');
1251 @nodes = $xc->findnodes('//ss:Worksheet[@ss:Name="' . $table . '"]');
1253 for (my $i=0; $i < @nodes; $i++) {
1254 my @nodesT = $nodes[$i]->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Table');
1255 if (@nodesT == 1 && $nodesT[0]->hasChildNodes()) {
1256 my $nodeR = $nodesT[0]->firstChild;
1257 return _processRows_Table($dbh, $frameworkcode, $nodeR, $table, $PKArray, undef, $fields2Delete);
1261 $debug and warn "Error _import_table_excel there's not worksheet for $table\n";
1264 }#_import_table_excel
1267 # Get the data from a cell on a ods file through the value attribute or the text node
1274 if ($node->nodeType == 1 && $node->nodeName =~ /(?:table:)?table-cell/) {
1275 if ($node->hasAttributeNS('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'value')) {
1276 $data = $node->getAttributeNS('urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'value');
1277 } elsif ($node->hasChildNodes()) {
1278 my @nodes2 = $node->getElementsByTagNameNS('urn:oasis:names:tc:opendocument:xmlns:text:1.0', 'p');
1279 if (@nodes2 == 1 && $nodes2[0]->hasChildNodes()) {
1280 $data = $nodes2[0]->firstChild->nodeValue;
1283 if ($node->hasAttributeNS('urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'number-columns-repeated')) {
1284 $repeated = $node->getAttributeNS('urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'number-columns-repeated');
1287 return ($data, $repeated);
1291 # Get the data from a row of a spreadsheet
1294 my ($frameworkcode, $node, $fields, $format) = @_;
1296 my $dataFields = {};
1297 my @dataFieldsA = ();
1298 if ($node && $node->hasChildNodes()) {
1299 my $node2 = $node->firstChild;
1300 my ($data, $repeated);
1305 if ($format && $format eq 'ods') {
1306 ($data, $repeated) = _getDataNodeODS($node2) if ($repeated <= 0);
1308 $ok = 1 if (defined($data));
1310 if ($node2->nodeType == 1 && $node2->nodeName =~ /(?:ss:)?Cell/) {
1311 my @nodes3 = $node2->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Data');
1312 if (@nodes3 == 1 && $nodes3[0]->hasChildNodes()) {
1313 $data = $nodes3[0]->firstChild->nodeValue;
1319 $data = '' if ($data eq '#');
1320 $data = $frameworkcode if ($fields->[$i] eq 'frameworkcode');
1321 $dataFields->{$fields->[$i]} = $data;
1322 push @dataFieldsA, $data;
1326 $node2 = $node2->nextSibling if ($repeated <= 0);
1329 return ($dataFields, \@dataFieldsA);
1333 # Get the data from the first row to know the column names
1336 my ($node, $fields, $format) = @_;
1338 if ($node && $node->hasChildNodes()) {
1339 my $node2 = $node->firstChild;
1340 my ($data, $repeated);
1342 if ($format && $format eq 'ods') {
1343 ($data, $repeated) = _getDataNodeODS($node2);
1344 push @$fields, $data if (defined($data));
1346 if ($node2->nodeType == 1 && $node2->nodeName =~ /(?:ss:)?Cell/) {
1347 my @nodes3 = $node2->getElementsByTagNameNS('urn:schemas-microsoft-com:office:spreadsheet', 'Data');
1348 if (@nodes3 == 1 && $nodes3[0]->hasChildNodes()) {
1349 $data = $nodes3[0]->firstChild->nodeValue;
1350 push @$fields, $data;
1354 $node2 = $node2->nextSibling;
1367 Koha Development Team <http://koha-community.org/>