From a1be9f26c2903d80300946c7be666cbf0bef6bf9 Mon Sep 17 00:00:00 2001 From: Aleisha Date: Tue, 26 Jan 2016 23:39:26 +0000 Subject: [PATCH] Bug 13952: Import and export authority types This patch amends C4::ImportExportFramework to work for authority types as well as MARC frameworks. New file: admin/import_export_authtype.pl Update: Ensuring we are passing the right column to the right tables. Update2: Making the error messages the same to be consistent with patch on Bug 15665 Update3: Fixing merge conflicts Update4: Fixing merge conflicts and removing tabs Update5: Getting rid of warns, making sure Import and Export of default authority will work Update6: Merge conflicts and making sure export of default auth type works Update7: Fixing merge conflicts and updating buttons to bootstrap3 To test: 1) Go to Admin -> Authority types 2) Confirm there are two new columns 'Export' and 'Import' in the table 3) Click 'Export' on an existing authority type and choose a file type, click 'Export' 4) Confirm that the authority type is exported as your chosen file type. Save the file 5) Create a new authority type 6) Import into your new authority type using the file you just exported 7) Confirm you are taken to auth_tag_structure.pl 8) Go back to Authority types 9) Export your new authority type. View the exported file and confirm the authtypecode has been updated to match the code you set for the new auth type 10) Click 'Import' next to any existing authority type and attempt to import a file that is not XML, CSV or ODS. Confirm that this fails and you are asked to import a file of the correct file type 11) Confirm Export and Import work for the Default authority type 12) Go to Admin -> MARC bibliographic framework 13) Confirm that the 'Export' and 'Import' functions still work here as well Sponsored-by: Catalyst IT Signed-off-by: Katrin Fischer Signed-off-by: Michal Denar Signed-off-by: Michal Denar Signed-off-by: Mazen Khallaf Signed-off-by: Michal Denar Signed-off-by: Katrin Fischer Signed-off-by: Fridolin Somers --- C4/ImportExportFramework.pm | 65 ++++++---- admin/import_export_authtype.pl | 102 +++++++++++++++ admin/import_export_framework.pl | 10 +- .../prog/en/modules/admin/authtypes.tt | 121 ++++++++++++++++++ 4 files changed, 273 insertions(+), 25 deletions(-) create mode 100755 admin/import_export_authtype.pl diff --git a/C4/ImportExportFramework.pm b/C4/ImportExportFramework.pm index 2ad5ac9b1c..9dbf1e165d 100644 --- a/C4/ImportExportFramework.pm +++ b/C4/ImportExportFramework.pm @@ -193,7 +193,7 @@ Functions for handling import/export. =head2 ExportFramework -Export all the information of a Framework to an excel "xml" file or OpenDocument SpreadSheet "ods" file. +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. return : succes @@ -202,7 +202,7 @@ succes sub ExportFramework { - my ($frameworkcode, $xmlStrRef, $mode) = @_; + my ($frameworkcode, $xmlStrRef, $mode, $frameworktype) = @_; my $dbh = C4::Context->dbh; if ($dbh) { @@ -229,8 +229,15 @@ sub ExportFramework } } - if (_export_table('marc_tag_structure', $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode)) { - if (_export_table('marc_subfield_structure', $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode)) { + my $table = 'marc_tag_structure'; + my $subtable = 'marc_subfield_structure'; + if ($frameworktype eq "authority") { + $table = 'auth_tag_structure'; + $subtable = 'auth_subfield_structure'; + } + + if (_export_table($table, $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode, $frameworktype)) { + if (_export_table($subtable, $dbh, ($mode eq 'csv')?$xmlStrRef:$dom, ($mode eq 'ods')?$elementSS:$root, $frameworkcode, $mode, $frameworktype)) { $$xmlStrRef = $dom->toString(1) if ($mode eq 'ods' || $mode eq 'excel'); return 1; } @@ -245,20 +252,20 @@ sub ExportFramework # Export all the data from a mysql table to an spreadsheet. sub _export_table { - my ($table, $dbh, $dom, $root, $frameworkcode, $mode) = @_; + my ($table, $dbh, $dom, $root, $frameworkcode, $mode, $frameworktype) = @_; if ($mode eq 'csv') { - _export_table_csv($table, $dbh, $dom, $root, $frameworkcode); + _export_table_csv($table, $dbh, $dom, $root, $frameworkcode, $frameworktype); } elsif ($mode eq 'ods') { - _export_table_ods($table, $dbh, $dom, $root, $frameworkcode); + _export_table_ods($table, $dbh, $dom, $root, $frameworkcode, $frameworktype); } else { - _export_table_excel($table, $dbh, $dom, $root, $frameworkcode); + _export_table_excel($table, $dbh, $dom, $root, $frameworkcode, $frameworktype); } } # Export the mysql table to an csv file sub _export_table_csv { - my ($table, $dbh, $strCSV, $root, $frameworkcode) = @_; + my ($table, $dbh, $strCSV, $root, $frameworkcode, $frameworktype) = @_; eval { # First row with the name of the columns @@ -274,6 +281,9 @@ sub _export_table_csv $$strCSV .= chr(10); # Populate rows with the data from mysql $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?'; + if ($frameworktype eq "authority") { + $query = 'SELECT * FROM ' . $table . ' WHERE authtypecode=?'; + } $sth = $dbh->prepare($query); $sth->execute($frameworkcode); my $data; @@ -306,7 +316,7 @@ sub _export_table_csv # Export the mysql table to an ods file sub _export_table_ods { - my ($table, $dbh, $dom, $root, $frameworkcode) = @_; + my ($table, $dbh, $dom, $root, $frameworkcode, $frameworktype) = @_; eval { my $elementTable = $dom->createElement('table:table'); @@ -335,6 +345,9 @@ sub _export_table_ods } # Populate rows with the data from mysql $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?'; + if ($frameworktype eq "authority") { + $query = 'SELECT * FROM ' . $table . ' WHERE authtypecode=?'; + } $sth = $dbh->prepare($query); $sth->execute($frameworkcode); my $data; @@ -372,7 +385,7 @@ sub _export_table_ods # Export the mysql table to an excel-xml (openoffice/libreoffice compatible) file sub _export_table_excel { - my ($table, $dbh, $dom, $root, $frameworkcode) = @_; + my ($table, $dbh, $dom, $root, $frameworkcode, $frameworktype) = @_; eval { my $elementWS = $dom->createElement('Worksheet'); @@ -402,6 +415,9 @@ sub _export_table_excel } # Populate rows with the data from mysql $query = 'SELECT * FROM ' . $table . ' WHERE frameworkcode=?'; + if ($frameworktype eq "authority") { + $query = 'SELECT * FROM ' . $table . ' WHERE authtypecode=?'; + } $sth = $dbh->prepare($query); $sth->execute($frameworkcode); my $data; @@ -433,12 +449,6 @@ sub _export_table_excel return 1; }#_export_table_excel - - - - - - # Format chars problematics to a correct format for xml. sub _parseContent2Xml { @@ -623,7 +633,7 @@ sub _getMeta =head2 ImportFramework -Import all the information of a Framework from a excel-xml/ods file. +Import all the information of a MARC or Authority Type Framework from a excel-xml/ods file. return : success @@ -632,7 +642,7 @@ success sub ImportFramework { - my ($filename, $frameworkcode, $deleteFilename) = @_; + my ($filename, $frameworkcode, $deleteFilename, $frameworktype) = @_; my $tempdir; my $ok = -1; @@ -662,13 +672,21 @@ sub ImportFramework # They are text files, so open it to read open($dom, '<', $filename); } + + my $table = 'marc_tag_structure'; + my $subtable = 'marc_subfield_structure'; + if ($frameworktype eq "authority") { + $table = 'auth_tag_structure'; + $subtable = 'auth_subfield_structure'; + } + if ($dom) { # Process both tables my $numDeleted = 0; my $numDeletedAux = 0; - if (($numDeletedAux = _import_table($dbh, 'marc_tag_structure', $frameworkcode, $dom, ['frameworkcode', 'tagfield'], $extension)) >= 0) { + if (($numDeletedAux = _import_table($dbh, $table, $frameworkcode, $dom, ['frameworkcode', 'tagfield'], $extension, $frameworktype)) >= 0) { $numDeleted += $numDeletedAux if ($numDeletedAux > 0); - if (($numDeletedAux = _import_table($dbh, 'marc_subfield_structure', $frameworkcode, $dom, ['frameworkcode', 'tagfield', 'tagsubfield'], $extension)) >= 0) { + if (($numDeletedAux = _import_table($dbh, $subtable, $frameworkcode, $dom, ['frameworkcode', 'tagfield', 'tagsubfield'], $extension, $frameworktype)) >= 0) { $numDeleted += $numDeletedAux if ($numDeletedAux > 0); $ok = ($numDeleted > 0)?$numDeleted:0; } @@ -789,7 +807,7 @@ sub _check_validity_worksheet # Import the data from an excel-xml/ods to mysql tables. sub _import_table { - my ($dbh, $table, $frameworkcode, $dom, $PKArray, $format) = @_; + my ($dbh, $table, $frameworkcode, $dom, $PKArray, $format, $frameworktype) = @_; my %fields2Delete; my $query; my @fields; @@ -798,6 +816,9 @@ sub _import_table @fields = @$PKArray; shift @fields; $query = 'SELECT ' . join(',', @fields) . ' FROM ' . $table . ' WHERE frameworkcode=?'; + if ($frameworktype eq "authority") { + $query = 'SELECT ' . join(',', @fields) . ' FROM ' . $table . ' WHERE authtypecode=?'; + } my $sth = $dbh->prepare($query); $sth->execute($frameworkcode); my $field; diff --git a/admin/import_export_authtype.pl b/admin/import_export_authtype.pl new file mode 100755 index 0000000000..cbf4a168a2 --- /dev/null +++ b/admin/import_export_authtype.pl @@ -0,0 +1,102 @@ +#!/usr/bin/perl + +# Copyright 2016 Aleisha Amohia +# +# This file is part of Koha. +# +# Koha is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# Koha is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Koha; if not, see . + + +use strict; +use warnings; +use CGI qw ( -utf8 ); +use CGI::Cookie; +use C4::Context; +use C4::Auth qw/check_cookie_auth/; +use C4::ImportExportFramework; + +my %cookies = CGI::Cookie->fetch(); +my $authenticated = 0; +my ($auth_status, $sessionID); +if (exists $cookies{'CGISESSID'}) { + ($auth_status, $sessionID) = check_cookie_auth( + $cookies{'CGISESSID'}->value, + { parameters => 'parameters_remaining_permissions' }, + ); +} +if ($auth_status eq 'ok') { + $authenticated = 1; +} + +my $input = new CGI; + +unless ($authenticated) { + print $input->header(-type => 'text/plain', -status => '403 Forbidden'); + exit 0; +} + +my $authtypecode = $input->param('authtypecode') || 'default'; +my $action = $input->param('action') || 'export'; + +## Exporting +if ($action eq 'export' && $input->request_method() eq 'GET') { + my $strXml = ''; + my $format = $input->param('type_export_' . $authtypecode); + if ($authtypecode eq 'default') { + $format = $input->param('type_export_'); + ExportFramework('', \$strXml, $format, 'authority'); + } else { + ExportFramework($authtypecode, \$strXml, $format, 'authority'); + } + + if ($format eq 'csv') { + # CSV file + + # Correctly set the encoding to output plain text in UTF-8 + binmode(STDOUT,':encoding(UTF-8)'); + print $input->header(-type => 'application/vnd.ms-excel', -attachment => 'export_' . $authtypecode . '.csv'); + print $strXml; + } elsif ($format eq 'excel') { + # Excel-xml file + print $input->header(-type => 'application/excel', -attachment => 'export_' . $authtypecode . '.xml'); + print $strXml; + } else { + # ODS file + my $strODS = ''; + createODS($strXml, 'en', \$strODS); + print $input->header(-type => 'application/vnd.oasis.opendocument.spreadsheet', -attachment => 'export_' . $authtypecode . '.ods'); + print $strODS; + } +## Importing +} elsif ($input->request_method() eq 'POST') { + my $ok = -1; + my $fieldname = 'file_import_' . $authtypecode; + my $filename = $input->param($fieldname); + # upload the input file + if ($filename && $filename =~ /\.(csv|ods|xml)$/i) { + my $extension = $1; + my $uploadFd = $input->upload($fieldname); + if ($uploadFd && !$input->cgi_error) { + my $tmpfilename = $input->tmpFileName($input->param($fieldname)); + $filename = $tmpfilename . '.' . $extension; # rename the tmp file with the extension + $ok = ImportFramework($filename, $authtypecode, 1, 'authority') if (rename($tmpfilename, $filename)); + } + } + if ($ok >= 0) { # If everything went ok go to the authority type marc structure + print $input->redirect( -location => '/cgi-bin/koha/admin/auth_tag_structure.pl?authtypecode=' . $authtypecode); + } else { + # If something failed go to the list of authority types and show message + print $input->redirect( -location => '/cgi-bin/koha/admin/authtypes.pl?error_import_export=' . $authtypecode); + } +} diff --git a/admin/import_export_framework.pl b/admin/import_export_framework.pl index b2dec83dad..459ba1fed6 100755 --- a/admin/import_export_framework.pl +++ b/admin/import_export_framework.pl @@ -52,8 +52,12 @@ my $action = $input->param('action') || 'export'; ## Exporting if ($action eq 'export' && $input->request_method() eq 'GET') { my $strXml = ''; - my $format = $input->param('type_export_' . $framework_name); - ExportFramework($frameworkcode, \$strXml, $format); + my $format = $input->param('type_export_' . $frameworkcode); + if ($frameworkcode eq 'default') { + ExportFramework('', \$strXml, $format, 'biblio'); + } else { + ExportFramework($frameworkcode, \$strXml, $format, 'biblio'); + } if ($format eq 'csv') { # CSV file @@ -81,7 +85,7 @@ if ($action eq 'export' && $input->request_method() eq 'GET') { if ($uploadFd && !$input->cgi_error) { my $tmpfilename = $input->tmpFileName(scalar $input->param($fieldname)); $filename = $tmpfilename . '.' . $extension; # rename the tmp file with the extension - $ok = ImportFramework($filename, $frameworkcode, 1) if (rename($tmpfilename, $filename)); + $ok = ImportFramework($filename, $frameworkcode, 1, 'biblio') if (rename($tmpfilename, $filename)); } } if ($ok >= 0) { # If everything went ok go to the framework marc structure diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/authtypes.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/authtypes.tt index 83338af0f6..f1251a8b53 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/authtypes.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/authtypes.tt @@ -191,8 +191,62 @@ Authority types › Administration › Koha
  • MARC structure
  • Edit
    • [% IF authority_type.authtypecode %]
  • Delete
    • [% END %] + +
  • Export
    • + +
  • Import
    • + + + + + + [% END %] @@ -214,16 +268,83 @@ Authority types › Administration › Koha [% INCLUDE 'datatables.inc' %] [% Asset.js("js/admin-menu.js") | $raw %] [% END %] -- 2.39.5