6 # This script checks for required updates to the database.
8 # Part of the Koha Library Software www.koha.org
9 # Licensed under the GPL.
12 # - Would also be a good idea to offer to do a backup at this time...
14 # NOTE: If you do something more than once in here, make it table driven.
22 use C4::Context("/etc/koha.conf.tmp");
24 # FIXME - /etc/koha.conf might not exist, so shouldn't use
27 # FIXME - The user might be installing a new database, so can't rely
28 # on /etc/koha.conf anyway.
35 %existingtables, # tables already in database
39 $type, $null, $key, $default, $extra,
40 $prefitem, # preference item in systempreferences table
43 my $dbh = C4::Context->dbh;
48 # Tables to add if they don't exist
50 shelfcontents => "( shelfnumber int not null,
51 itemnumber int not null,
53 bookshelf => "( shelfnumber int auto_increment primary key,
54 shelfname char(255))",
55 z3950queue => "( id int auto_increment primary key,
64 identifier char(30))",
65 z3950results => "( id int auto_increment primary key,
75 branchrelations => "( branchcode varchar(4),
76 categorycode varchar(4))",
77 websites => "( websitenumber int(11) NOT NULL auto_increment,
78 biblionumber int(11) NOT NULL default '0',
82 PRIMARY KEY (websitenumber) )",
83 marcrecorddone => "( isbn char(40),
86 controlnumber char(40))",
87 uploadedmarc => "( id int(11) NOT NULL auto_increment PRIMARY KEY,
89 hidden smallint(6) default NULL,
90 name varchar(255) default NULL)",
91 ethnicity => "( code varchar(10) NOT NULL default '',
92 name varchar(255) default NULL,
93 PRIMARY KEY (code) )",
94 sessions => "( sessionID varchar(255) NOT NULL default '',
95 userid varchar(255) default NULL,
96 ip varchar(16) default NULL,
98 PRIMARY KEY (sessionID) )",
99 sessionqueries => "( sessionID varchar(255) NOT NULL default '',
100 userid char(100) NOT NULL default '',
101 ip char(18) NOT NULL default '',
102 url text NOT NULL default '' )",
103 bibliothesaurus => "( id bigint(20) NOT NULL auto_increment,
104 freelib char(255) NOT NULL default '',
105 stdlib char(255) NOT NULL default '',
106 category char(10) NOT NULL default '',
107 level tinyint(4) NOT NULL default '1',
108 hierarchy char(80) NOT NULL default '',
109 father bigint(20) NOT NULL default '',
111 KEY freelib (freelib),
113 KEY category (category),
114 KEY hierarchy (hierarchy)
117 bibid bigint(20) unsigned NOT NULL auto_increment,
118 biblionumber int(11) NOT NULL default '0',
119 datecreated date NOT NULL default '0000-00-00',
120 datemodified date default NULL,
121 origincode char(20) default NULL,
123 KEY origincode (origincode),
124 KEY biblionumber (biblionumber)
126 marc_blob_subfield => "(
127 blobidlink bigint(20) NOT NULL auto_increment,
128 subfieldvalue longtext NOT NULL,
129 PRIMARY KEY (blobidlink)
131 marc_subfield_structure => "(
132 tagfield char(3) NOT NULL default '',
133 tagsubfield char(1) NOT NULL default '',
134 liblibrarian char(255) NOT NULL default '',
135 libopac char(255) NOT NULL default '',
136 repeatable tinyint(4) NOT NULL default '0',
137 mandatory tinyint(4) NOT NULL default '0',
138 kohafield char(40) default NULL,
139 tab tinyint(1) default NULL,
140 authorised_value char(10) default NULL,
141 thesaurus_category char(10) default NULL,
142 value_builder char(80) default NULL,
143 PRIMARY KEY (tagfield,tagsubfield),
144 KEY kohafield (kohafield),
147 marc_subfield_table => "(
148 subfieldid bigint(20) unsigned NOT NULL auto_increment,
149 bibid bigint(20) unsigned NOT NULL default '0',
150 tag char(3) NOT NULL default '',
151 tagorder tinyint(4) NOT NULL default '1',
152 tag_indicator char(2) NOT NULL default '',
153 subfieldcode char(1) NOT NULL default '',
154 subfieldorder tinyint(4) NOT NULL default '1',
155 subfieldvalue varchar(255) default NULL,
156 valuebloblink bigint(20) default NULL,
157 PRIMARY KEY (subfieldid),
160 KEY tag_indicator (tag_indicator),
161 KEY subfieldorder (subfieldorder),
162 KEY subfieldcode (subfieldcode),
163 KEY subfieldvalue (subfieldvalue),
164 KEY tagorder (tagorder)
166 marc_tag_structure => "(
167 tagfield char(3) NOT NULL default '',
168 liblibrarian char(255) NOT NULL default '',
169 libopac char(255) NOT NULL default '',
170 repeatable tinyint(4) NOT NULL default '0',
171 mandatory tinyint(4) NOT NULL default '0',
172 authorised_value char(10) default NULL,
173 PRIMARY KEY (tagfield)
176 bibid bigint(20) NOT NULL default '0',
177 tag char(3) NOT NULL default '',
178 tagorder tinyint(4) NOT NULL default '1',
179 subfieldid char(1) NOT NULL default '',
180 subfieldorder tinyint(4) NOT NULL default '1',
181 word varchar(255) NOT NULL default '',
182 sndx_word varchar(255) NOT NULL default '',
185 KEY tagorder (tagorder),
186 KEY subfieldid (subfieldid),
187 KEY subfieldorder (subfieldorder),
189 KEY sndx_word (sndx_word)
191 marc_breeding => "( id bigint(20) NOT NULL auto_increment,
192 file varchar(80) NOT NULL default '',
193 isbn varchar(10) NOT NULL default '',
194 title varchar(128) default NULL,
195 author varchar(80) default NULL,
197 encoding varchar(40) default NULL,
202 authorised_values => "(id int(11) NOT NULL auto_increment,
203 category char(10) NOT NULL default '',
204 authorised_value char(80) NOT NULL default '',
209 userflags => "( bit int(11) NOT NULL default '0',
210 flag char(30), flagdesc char(255),
215 my %requirefields = (
216 biblio => { 'abstract' => 'text' },
217 deletedbiblio => { 'abstract' => 'text' },
219 'lccn' => 'char(25)',
220 'url' => 'varchar(255)',
223 deletedbiblioitems => {
224 'lccn' => 'char(25)',
225 'url' => 'varchar(255)',
228 branchtransfers => { 'datearrived' => 'datetime' },
229 statistics => { 'borrowernumber' => 'int(11)' },
231 'invoicedisc' => 'float(6,4)',
232 'nocalc' => 'int(11)'
235 'userid' => 'char(30)',
236 'password' => 'char(30)',
237 'flags' => 'int(11)',
238 'textmessaging' => 'varchar(30)'
240 aqorders => { 'budgetdate' => 'date' },
242 #added so that reference items are not available for reserves...
243 itemtypes => { 'notforloan' => 'smallint(6)' },
244 systempreferences => { 'explanation' => 'char(80)' },
245 z3950servers => { 'syntax' => 'char(80)' },
248 my %dropable_table = (
249 classification => 'classification',
250 multipart => 'multipart',
251 multivolume => 'multivolume',
252 newitems => 'newitems',
253 procedures => 'procedures',
254 publisher => 'publisher',
255 searchstats => 'searchstats',
256 serialissues => 'serialissues',
259 # The tabledata hash contains data that should be in the tables.
260 # The uniquefieldrequired hash entry is used to determine which (if any) fields
261 # must not exist in the table for this row to be inserted. If the
262 # uniquefieldrequired entry is already in the table, the existing data is not
268 uniquefieldrequired => 'bit',
270 flag => 'superlibrarian',
271 flagdesc => 'Access to all librarian functions',
275 uniquefieldrequired => 'bit',
278 flagdesc => 'Circulate books',
282 uniquefieldrequired => 'bit',
285 flagdesc => 'View Catalogue (Librarian Interface)',
289 uniquefieldrequired => 'bit',
291 flag => 'parameters',
292 flagdesc => 'Set Koha system paramters',
296 uniquefieldrequired => 'bit',
299 flagdesc => 'Add or modify borrowers',
303 uniquefieldrequired => 'bit',
305 flag => 'permissions',
306 flagdesc => 'Set user permissions',
310 uniquefieldrequired => 'bit',
312 flag => 'reserveforothers',
313 flagdesc => 'Reserve books for patrons',
317 uniquefieldrequired => 'bit',
320 flagdesc => 'Borrow books',
324 uniquefieldrequired => 'bit',
326 flag => 'reserveforself',
327 flagdesc => 'Reserve books for self',
331 uniquefieldrequired => 'bit',
333 flag => 'editcatalogue',
334 flagdesc => 'Edit Catalogue (Modify bibliographic/holdings data)',
338 uniquefieldrequired => 'bit',
340 flag => 'updatecharges',
341 flagdesc => 'Update borrower charges',
345 systempreferences => [
347 uniquefieldrequired => 'variable',
348 variable => 'autoMemberNum',
350 explanation => '1 or 0. If 1, Member number is auto-calculated'
353 uniquefieldrequired => 'variable',
354 variable => 'acquisitions',
357 'normal or simple : whether to use "acqui" or "acqui.simple" acquisition system'
360 uniquefieldrequired => 'variable',
361 variable => 'dateformat',
363 explanation => 'metric, us, or iso'
366 uniquefieldrequired => 'variable',
367 variable => 'template',
369 explanation => 'template default name'
372 uniquefieldrequired => 'variable',
373 variable => 'autoBarcode',
375 explanation => '1 or 0. If 1, Barcode is auto-calculated'
378 uniquefieldrequired => 'variable',
379 variable => 'insecure',
382 'if YES, no auth at all is needed. Be careful if you set this to yes !'
385 uniquefieldrequired => 'variable',
386 variable => 'authoritysep',
389 'the separator used in authority/thesaurus. Usually --'
392 uniquefieldrequired => 'variable',
393 variable => 'opaclanguages',
395 explanation => 'languages'
398 uniquefieldrequired => 'variable',
399 variable => 'opacthemes',
401 explanation => 'theme'
404 uniquefieldrequired => 'variable',
405 variable => 'timeout',
407 explanation => 'login timeout'
410 uniquefieldrequired => 'variable',
413 explanation => 'MARC support (ON or OFF)'
416 uniquefieldrequired => 'variable',
417 variable => 'marcflavour',
420 'your MARC flavor (MARC21 or UNIMARC) used for character encoding'
423 uniquefieldrequired => 'variable',
424 variable => 'checkdigit',
427 'none= no check on member cardnumber. katipo= katipo check'
430 uniquefieldrequired => 'variable',
431 variable => 'dateformat',
434 'date format (US mm/dd/yyyy, metric dd/mm/yyy, ISO yyyy/mm/dd) '
437 uniquefieldrequired => 'variable',
438 variable => 'KohaAdminEmailAddress',
439 value => 'your.mail@here',
440 explanation => 'the email adress where borrowers modifs are sent'
446 my %fielddefinitions = (
449 field => 'printername',
458 field => 'bookfundid',
472 extra => 'auto_increment'
482 # Get version of MySQL database engine.
483 my $mysqlversion = `mysqld --version`;
484 $mysqlversion =~ /Ver (\S*) /;
486 if ( $mysqlversion ge '3.23' ) {
487 print "Could convert to MyISAM database tables...\n";
490 #---------------------------------
493 # Collect all tables into a list
494 $sth = $dbh->prepare("show tables");
496 while ( my ($table) = $sth->fetchrow ) {
497 $existingtables{$table} = 1;
500 # Now add any missing tables
501 foreach $table ( keys %requiretables ) {
502 print "Checking $table table...\n" if $debug;
503 unless ( $existingtables{$table} ) {
504 print "Adding $table table...\n";
505 my $sth = $dbh->prepare("create table $table $requiretables{$table}");
508 print "Error : $sth->errstr \n";
514 # now drop useless tables
515 foreach $table ( keys %dropable_table ) {
516 print "Dropping unused tables...\n" if $debug;
517 if ( $existingtables{$table} ) {
518 $dbh->do("drop table $table");
520 print "Error : $dbh->errstr \n";
524 unless ( $existingtables{'z3950servers'} ) {
525 print "Adding z3950servers table...\n";
526 my $sti = $dbh->prepare( "create table z3950servers (
538 $sti = $dbh->prepare( "insert into z3950servers
539 values ('z3950.loc.gov',
543 'Library of Congress',
549 #---------------------------------
552 foreach $table ( keys %requirefields ) {
553 print "Check table $table\n" if $debug;
554 $sth = $dbh->prepare("show columns from $table");
557 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
559 $types{$column} = $type;
561 foreach $column ( keys %{ $requirefields{$table} } ) {
562 print " Check column $column\n" if $debug;
563 if ( !$types{$column} ) {
565 # column doesn't exist
566 print "Adding $column field to $table table...\n";
567 $query = "alter table $table
568 add column $column " . $requirefields{$table}->{$column};
569 print "Execute: $query\n" if $debug;
570 my $sti = $dbh->prepare($query);
573 print "**Error : $sti->errstr \n";
580 foreach $table ( keys %fielddefinitions ) {
581 print "Check table $table\n" if $debug;
582 $sth = $dbh->prepare("show columns from $table");
585 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
587 $definitions->{$column}->{type} = $type;
588 $definitions->{$column}->{null} = $null;
589 $definitions->{$column}->{key} = $key;
590 $definitions->{$column}->{default} = $default;
591 $definitions->{$column}->{extra} = $extra;
593 my $fieldrow = $fielddefinitions{$table};
594 foreach my $row (@$fieldrow) {
595 my $field = $row->{field};
596 my $type = $row->{type};
597 my $null = $row->{null};
598 my $key = $row->{key};
599 my $default = $row->{default};
600 my $extra = $row->{extra};
601 my $def = $definitions->{$field};
602 unless ( $type eq $def->{type}
603 && $null eq $def->{null}
604 && $key eq $def->{key}
605 && $default eq $def->{default}
606 && $extra eq $def->{extra} )
612 if ( $key eq 'PRI' ) {
613 $key = 'PRIMARY KEY';
615 unless ( $extra eq 'auto_increment' ) {
620 "alter table $table change $field $field $type $null $key $extra default ?"
622 $sth->execute($default);
623 print " Alter $field in $table\n";
628 # Get list of columns from items table
631 $sth = $dbh->prepare("show columns from items");
633 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
635 $itemtypes{$column} = $type;
638 unless ( $itemtypes{'barcode'} eq 'varchar(20)' ) {
639 $itemtypes{'barcode'} =~ /varchar\((\d+)\)/;
641 if ( $oldlength < 20 ) {
642 print "Setting maximum barcode length to 20 (was $oldlength).\n";
645 "alter table items change barcode barcode varchar(20) not null");
650 # extending the timestamp in branchtransfers...
653 $sth = $dbh->prepare("show columns from branchtransfers");
655 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
657 $branchtransfers{$column} = $type;
660 unless ( $branchtransfers{'datesent'} eq 'datetime' ) {
661 print "Setting type of datesent in branchtransfers to datetime.\n";
664 "alter table branchtransfers change datesent datesent datetime");
668 unless ( $branchtransfers{'datearrived'} eq 'datetime' ) {
669 print "Setting type of datearrived in branchtransfers to datetime.\n";
672 "alter table branchtransfers change datearrived datearrived datetime");
676 # changing the branchcategories table around...
677 my %branchcategories;
679 $sth = $dbh->prepare("show columns from branchcategories");
681 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
683 $branchcategories{$column} = $type;
686 unless ( $branchcategories{'categorycode'} eq 'varchar(4)' ) {
688 "Setting type of categorycode in branchcategories to varchar(4),\n and making the primary key.\n";
691 "alter table branchcategories change categorycode categorycode varchar(4) not null"
696 "alter table branchcategories add primary key (categorycode)");
700 unless ( $branchcategories{'categoryname'} eq 'text' ) {
701 print "Changing branchcode in branchcategories to categoryname text.\n";
704 "alter table branchcategories change branchcode categoryname text");
708 unless ( $branchcategories{'codedescription'} eq 'text' ) {
710 "Replacing branchholding in branchcategories with codedescription text.\n";
713 "alter table branchcategories change branchholding codedescription text"
718 # Populate tables with required data
720 foreach my $table ( keys %tabledata ) {
721 print "Checking for data required in table $table...\n";
722 my $tablerows = $tabledata{$table};
723 foreach my $row (@$tablerows) {
724 my $uniquefieldrequired = $row->{uniquefieldrequired};
725 my $uniquevalue = $row->{$uniquefieldrequired};
728 "select $uniquefieldrequired from $table where $uniquefieldrequired=?"
730 $sth->execute($uniquevalue);
731 unless ( $sth->rows ) {
732 print "Adding row to $table: ";
736 foreach my $field ( keys %$row ) {
737 (next) if ( $field eq 'uniquefieldrequired' );
738 my $value = $row->{$field};
739 push @values, $value;
740 print " $field => $value";
741 $fieldlist .= "$field,";
742 $placeholders .= "?,";
745 $fieldlist =~ s/,$//;
746 $placeholders =~ s/,$//;
749 "insert into $table ($fieldlist) values ($placeholders)");
750 $sth->execute(@values);
760 # Revision 1.44 2003/05/03 05:39:57 rangi
762 # (Wording changes in the explanation fields in system preferences)
764 # Revision 1.43 2003/05/02 23:01:09 rangi
765 # Adding the textmessaging column to the borrowers table.
766 # insertdata.pl is expecting this to exist, and hence modifying/adding
767 # borrowers was broken.
769 # Also ran they script thru perltidy
771 # Revision 1.42 2003/04/29 16:53:25 tipaul
772 # really proud of this commit :-)
773 # z3950 search and import seems to works fine.
774 # Let me explain how :
775 # * a "search z3950" button is added in the addbiblio template.
776 # * when clicked, a popup appears and z3950/search.pl is called
777 # * z3950/search.pl calls addz3950search in the DB
778 # * the z3950 daemon retrieve the records and stores them in z3950results AND in marc_breeding table.
779 # * as long as there as searches pending, the popup auto refresh every 2 seconds, and says how many searches are pending.
780 # * when the user clicks on a z3950 result => the parent popup is called with the requested biblio, and auto-filled
783 # * character encoding support : (It's a nightmare...) In the z3950servers table, a "encoding" column has been added. You can put "UNIMARC" or "USMARC" in this column. Depending on this, the char_decode in C4::Biblio.pm replaces marc-char-encode by an iso 8859-1 encoding. Note that in the breeding import this value has been added too, for a better support.
784 # * the marc_breeding and z3950* tables have been modified : they have an encoding column and the random z3950 number is stored too for convenience => it's the key I use to list only requested biblios in the popup.
786 # Revision 1.41 2003/04/29 08:09:44 tipaul
787 # z3950 support is coming...
788 # * adding a syntax column in z3950 table = this column will say wether the z3950 must be called with PerferedRecordsyntax => USMARC or PerferedRecordsyntax => UNIMARC. I tried some french UNIMARC z3950 servers, and some only send USMARC, some only UNIMARC, some can answer with both.
789 # Note this is a 1st draft. More to follow (today ? I hope).
791 # Revision 1.40 2003/04/22 10:48:27 wolfpac444
792 # Added "father" column to bibliothesaurus table
794 # Revision 1.39 2003/04/04 08:45:00 tipaul
795 # last commits before 1.9.1
797 # Revision 1.38 2003/03/18 10:58:19 tipaul
798 # adding checkdigit parameter that choose how to check the members cardnumber.
800 # * none = no checking
801 # * katipo = checked as before
803 # Revision 1.37 2003/01/30 01:47:48 acli
804 # Corrected syntax error reported by Benedict
806 # Made the indentation somewhat easier to read; the messiness probably caused
807 # the original syntax error.
809 # Revision 1.36 2003/01/28 15:13:30 tipaul
810 # userflag table now created in upgrade script (bugfix #171)
812 # Revision 1.35 2003/01/27 03:12:49 acli
813 # Reworded the description for "acquisitions" to make it fit on the screen
815 # Added "iso" to dateformat, since dateformat is not yet being used anyway
817 # Revision 1.34 2003/01/23 12:30:02 tipaul
818 # introducint marcflavour in systempref file : used for character decoding
820 # Revision 1.33 2003/01/21 09:03:27 tipaul
821 # bugfix (NOTE : this bugs makes installation of the 1.3.3 a little fuzzy. Please fix your DB if you installed 1.3.3)
823 # Revision 1.32 2003/01/16 10:29:45 tipaul
824 # adding a MARC parameter in systempref ( which is ON or OFF)
825 # the search will be a marc search if MARC=ON
826 # and a standard (v1.2) search if MARC=OFF
828 # Revision 1.31 2003/01/06 13:32:43 tipaul
829 # *** empty log message ***
831 # Revision 1.29 2003/01/06 11:14:11 tipaul
832 # last bugfixes before 1.3.3 : systempref table correctly filled
834 # Revision 1.28 2002/12/10 13:27:47 tipaul
835 # bugfixes (davide mails in koha-dev)
837 # Revision 1.27 2002/11/26 15:04:54 tipaul
838 # road to 1.3.2. Updating db structure during installation
840 # Revision 1.26 2002/11/12 17:42:40 tonnesen
841 # Merged some features over from rel-1-2, including primary key checking.
843 # Revision 1.25 2002/11/12 16:44:38 tipaul
846 # * adding value_builder : you can map a subfield in the marc_subfield_structure to a sub stored in "value_builder" directory. In this directory you can create screen used to build values with any method. In this commit is a 1st draft of the builder for 100$a unimarc french subfield, which is composed of 35 digits, with 12 differents values (only the 4th first are provided for instance)
848 # Revision 1.24 2002/10/30 14:00:23 arensb
849 # (bug fix): Fixed typo.
851 # Revision 1.23 2002/10/25 10:55:46 tipaul
853 # * bugfixes and improvements
854 # * manage mandatory MARC subfields
855 # * new table : authorised_values. this table contains categories and authorised values for the category. On MARC management, you can map a subfield to a authorised_values category. If you do this, the subfield can only be filled with a authorised_value of the selected category.
856 # this submit contains everything needed :
859 # * "links" management
860 # * creation of a html-list if a subfield is mapped to an authorised value.
862 # Note this is different from authorities support, which will come soon.
863 # The authorised_values is supposed to contains a "small" number of authorised values for a category (less than 50-100). If you enter more authorised values than this, it should be hard to find what you want in a BIG list...
865 # Revision 1.22 2002/10/15 10:08:19 tipaul
866 # fixme corrected, re-indent and adding the marc_breeding table (see commit of marcimport.pl for more explanations about breeding)
868 # Revision 1.21 2002/10/14 11:48:59 tipaul
871 # Revision 1.20 2002/10/10 04:49:41 arensb
872 # Added some FIXME comments.
874 # Revision 1.19 2002/10/05 10:17:17 arensb
875 # Merged with arensb-context branch: use C4::Context->dbh instead of
876 # &C4Connect, and generally prefer C4::Context over C4::Database.
878 # Revision 1.18.2.2 2002/10/05 06:18:43 arensb
879 # Added a whole mess of FIXME comments.
881 # Revision 1.18.2.1 2002/10/04 02:46:00 arensb
882 # Use C4::Connect instead of C4::Database, C4::Connect->dbh instead
885 # Revision 1.18 2002/09/24 13:50:55 tipaul
886 # long WAS the road to 1.3.0...
887 # coming VERY SOON NOW...
888 # modifying installer and buildrelease to update the DB
890 # Revision 1.17 2002/09/24 12:57:35 tipaul
891 # long WAS the road to 1.3.0...
892 # coming VERY SOON NOW...
893 # modifying installer and buildrelease to update the DB
895 # Revision 1.16 2002/07/31 02:34:27 finlayt
897 # added "notforloan" field to the itemtypes table.
899 # Revision 1.15 2002/07/20 22:30:06 rangi
900 # Making sure fix makes it into the main branch as well
903 # Revision 1.14 2002/07/08 16:20:26 tonnesen
904 # Added sessionqueries table and password/userid fields to borrowers table
906 # Revision 1.13 2002/07/04 18:05:36 tonnesen
909 # Revision 1.12 2002/07/04 16:41:06 tonnesen
910 # Merged changes from rel-1-2. Abstracted table structure changes by alan.