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");
23 # FIXME - /etc/koha.conf might not exist, so shouldn't use
26 # FIXME - The user might be installing a new database, so can't rely
27 # on /etc/koha.conf anyway.
34 %existingtables, # tables already in database
38 $type, $null, $key, $default, $extra,
39 $prefitem, # preference item in systempreferences table
42 my $dbh = C4::Context->dbh;
47 # Tables to add if they don't exist
49 shelfcontents=>"( shelfnumber int not null,
50 itemnumber int not null,
52 bookshelf=>"( shelfnumber int auto_increment primary key,
53 shelfname char(255))",
54 z3950queue=>"( id int auto_increment primary key,
63 identifier char(30))",
64 z3950results=>"( id int auto_increment primary key,
74 branchrelations=>"( branchcode varchar(4),
75 categorycode varchar(4))",
76 websites=>"( websitenumber int(11) NOT NULL auto_increment,
77 biblionumber int(11) NOT NULL default '0',
81 PRIMARY KEY (websitenumber) )",
82 marcrecorddone=>"( isbn char(40),
85 controlnumber char(40))",
86 uploadedmarc=>"( id int(11) NOT NULL auto_increment PRIMARY KEY,
88 hidden smallint(6) default NULL,
89 name varchar(255) default NULL)",
90 ethnicity=>"( code varchar(10) NOT NULL default '',
91 name varchar(255) default NULL,
92 PRIMARY KEY (code) )",
93 sessions=>"( sessionID varchar(255) NOT NULL default '',
94 userid varchar(255) default NULL,
95 ip varchar(16) default NULL,
97 PRIMARY KEY (sessionID) )",
98 sessionqueries=>"( sessionID varchar(255) NOT NULL default '',
99 userid char(100) NOT NULL default '',
100 ip char(18) NOT NULL default '',
101 url text NOT NULL default '' )",
102 bibliothesaurus=> "( id bigint(20) NOT NULL auto_increment,
103 freelib char(255) NOT NULL default '',
104 stdlib char(255) NOT NULL default '',
105 category char(10) NOT NULL default '',
106 level tinyint(4) NOT NULL default '1',
107 hierarchy char(80) NOT NULL default '',
108 father bigint(20) NOT NULL default '',
110 KEY freelib (freelib),
112 KEY category (category),
113 KEY hierarchy (hierarchy)
116 bibid bigint(20) unsigned NOT NULL auto_increment,
117 biblionumber int(11) NOT NULL default '0',
118 datecreated date NOT NULL default '0000-00-00',
119 datemodified date default NULL,
120 origincode char(20) default NULL,
122 KEY origincode (origincode),
123 KEY biblionumber (biblionumber)
125 marc_blob_subfield => "(
126 blobidlink bigint(20) NOT NULL auto_increment,
127 subfieldvalue longtext NOT NULL,
128 PRIMARY KEY (blobidlink)
130 marc_subfield_structure => "(
131 tagfield char(3) NOT NULL default '',
132 tagsubfield char(1) NOT NULL default '',
133 liblibrarian char(255) NOT NULL default '',
134 libopac char(255) NOT NULL default '',
135 repeatable tinyint(4) NOT NULL default '0',
136 mandatory tinyint(4) NOT NULL default '0',
137 kohafield char(40) default NULL,
138 tab tinyint(1) default NULL,
139 authorised_value char(10) default NULL,
140 thesaurus_category char(10) default NULL,
141 value_builder char(80) default NULL,
142 PRIMARY KEY (tagfield,tagsubfield),
143 KEY kohafield (kohafield),
146 marc_subfield_table => "(
147 subfieldid bigint(20) unsigned NOT NULL auto_increment,
148 bibid bigint(20) unsigned NOT NULL default '0',
149 tag char(3) NOT NULL default '',
150 tagorder tinyint(4) NOT NULL default '1',
151 tag_indicator char(2) NOT NULL default '',
152 subfieldcode char(1) NOT NULL default '',
153 subfieldorder tinyint(4) NOT NULL default '1',
154 subfieldvalue varchar(255) default NULL,
155 valuebloblink bigint(20) default NULL,
156 PRIMARY KEY (subfieldid),
159 KEY tag_indicator (tag_indicator),
160 KEY subfieldorder (subfieldorder),
161 KEY subfieldcode (subfieldcode),
162 KEY subfieldvalue (subfieldvalue),
163 KEY tagorder (tagorder)
165 marc_tag_structure => "(
166 tagfield char(3) NOT NULL default '',
167 liblibrarian char(255) NOT NULL default '',
168 libopac char(255) NOT NULL default '',
169 repeatable tinyint(4) NOT NULL default '0',
170 mandatory tinyint(4) NOT NULL default '0',
171 authorised_value char(10) default NULL,
172 PRIMARY KEY (tagfield)
175 bibid bigint(20) NOT NULL default '0',
176 tag char(3) NOT NULL default '',
177 tagorder tinyint(4) NOT NULL default '1',
178 subfieldid char(1) NOT NULL default '',
179 subfieldorder tinyint(4) NOT NULL default '1',
180 word varchar(255) NOT NULL default '',
181 sndx_word varchar(255) NOT NULL default '',
184 KEY tagorder (tagorder),
185 KEY subfieldid (subfieldid),
186 KEY subfieldorder (subfieldorder),
188 KEY sndx_word (sndx_word)
190 marc_breeding =>"( id bigint(20) NOT NULL auto_increment,
191 file varchar(80) NOT NULL default '',
192 isbn varchar(10) NOT NULL default '',
193 title varchar(128) default NULL,
194 author varchar(80) default NULL,
200 authorised_values => "(id int(11) NOT NULL auto_increment,
201 category char(10) NOT NULL default '',
202 authorised_value char(80) NOT NULL default '',
207 userflags => "( bit int(11) NOT NULL default '0',
208 flag char(30), flagdesc char(255),
216 biblio=>{ 'abstract' => 'text' },
217 deletedbiblio=>{ 'abstract' => 'text' },
218 biblioitems=>{ 'lccn' => 'char(25)',
219 'url' => 'varchar(255)',
221 deletedbiblioitems=>{ 'lccn' => 'char(25)',
222 'url' => 'varchar(255)',
224 branchtransfers=>{ 'datearrived' => 'datetime' },
225 statistics=>{'borrowernumber' =>'int(11)'},
226 aqbooksellers=>{'invoicedisc' =>'float(6,4)',
227 'nocalc' => 'int(11)'},
228 borrowers=>{'userid' => 'char(30)',
229 'password' => 'char(30)',
230 'flags' => 'int(11)'},
231 aqorders=>{'budgetdate' => 'date'},
232 #added so that reference items are not available for reserves...
233 itemtypes=>{'notforloan' => 'smallint(6)'},
234 systempreferences =>{'explanation' => 'char(80)'},
238 classification =>'classification',
239 multipart =>'multipart',
240 multivolume =>'multivolume',
241 newitems =>'newitems',
242 procedures =>'procedures',
243 publisher =>'publisher',
244 searchstats =>'searchstats',
245 serialissues =>'serialissues',
249 # The tabledata hash contains data that should be in the tables.
250 # The uniquefieldrequired hash entry is used to determine which (if any) fields
251 # must not exist in the table for this row to be inserted. If the
252 # uniquefieldrequired entry is already in the table, the existing data is not
257 { uniquefieldrequired => 'bit', bit => 0, flag => 'superlibrarian', flagdesc => 'Access to all librarian functions', defaulton => 0 },
258 { uniquefieldrequired => 'bit', bit => 1, flag => 'circulate', flagdesc => 'Circulate books', defaulton => 0 },
259 { uniquefieldrequired => 'bit', bit => 2, flag => 'catalogue', flagdesc => 'View Catalogue (Librarian Interface)', defaulton => 0 },
260 { uniquefieldrequired => 'bit', bit => 3, flag => 'parameters', flagdesc => 'Set Koha system paramters', defaulton => 0 },
261 { uniquefieldrequired => 'bit', bit => 4, flag => 'borrowers', flagdesc => 'Add or modify borrowers', defaulton => 0 },
262 { uniquefieldrequired => 'bit', bit => 5, flag => 'permissions', flagdesc => 'Set user permissions', defaulton => 0 },
263 { uniquefieldrequired => 'bit', bit => 6, flag => 'reserveforothers', flagdesc => 'Reserve books for patrons', defaulton => 0 },
264 { uniquefieldrequired => 'bit', bit => 7, flag => 'borrow', flagdesc => 'Borrow books', defaulton => 1 },
265 { uniquefieldrequired => 'bit', bit => 8, flag => 'reserveforself', flagdesc => 'Reserve books for self', defaulton => 0 },
266 { uniquefieldrequired => 'bit', bit => 9, flag => 'editcatalogue', flagdesc => 'Edit Catalogue (Modify bibliographic/holdings data)', defaulton => 0 },
267 { uniquefieldrequired => 'bit', bit => 10, flag => 'updatecharges', flagdesc => 'Update borrower charges', defaulton => 0 },
269 systempreferences => [
270 { uniquefieldrequired => 'variable', variable => 'autoMemberNum', value => '1', explanation => '1 or else. If 1, Barcode is auto-calculated' },
271 { uniquefieldrequired => 'variable', variable => 'acquisitions', value => 'simple', explanation => 'normal or simple : whether to use "acqui" or "acqui.simple" acquisition system' },
272 { uniquefieldrequired => 'variable', variable => 'dateformat', value => 'metric', explanation => 'metric, us, or iso' },
273 { uniquefieldrequired => 'variable', variable => 'template', value => 'default', explanation => 'template default name' },
274 { uniquefieldrequired => 'variable', variable => 'autoBarcode', value => '1', explanation => '1 or else. If 1, Barcode is auto-calculated' },
275 { uniquefieldrequired => 'variable', variable => 'insecure', value => 'NO', explanation => 'if YES, no auth at all is needed. Be careful if you set this to yes !' },
276 { uniquefieldrequired => 'variable', variable => 'authoritysep', value => '--', explanation => 'the separator used in authority/thesaurus. Usually --' },
277 { uniquefieldrequired => 'variable', variable => 'opaclanguages', value => 'en', explanation => 'languages' },
278 { uniquefieldrequired => 'variable', variable => 'opacthemes', value => 'default', explanation => 'theme' },
279 { uniquefieldrequired => 'variable', variable => 'timeout', value => '12000000', explanation => 'login timeout' },
280 { uniquefieldrequired => 'variable', variable => 'marc', value => 'ON', explanation => 'MARC support (ON or OFF)' },
281 { uniquefieldrequired => 'variable', variable => 'marcflavour', value => 'MARC21', explanation => 'your MARC flavor (MARC21 or UNIMARC) used for character encoding' },
282 { uniquefieldrequired => 'variable', variable => 'checkdigit', value => 'katipo', explanation => 'none= no check on member cardnumber. katipo= katipo check' },
283 { uniquefieldrequired => 'variable', variable => 'dateformat', value => 'ISO', explanation => 'date format (US mm/dd/yyyy, metric dd/mm/yyy, ISO yyyy/mm/dd) ' },
289 my %fielddefinitions=(
291 { field => 'printername', type => 'char(40)', null => '', key => 'PRI', default => '' },
294 { field => 'bookfundid', type => 'char(5)', null => '', key => 'PRI', default => '' },
297 { field => 'id', type => 'int', null => '', key => 'PRI', default => '', extra => 'auto_increment' },
308 # Get version of MySQL database engine.
309 my $mysqlversion=`mysqld --version`;
310 $mysqlversion=~/Ver (\S*) /;
312 if ($mysqlversion ge '3.23') {
313 print "Could convert to MyISAM database tables...\n";
316 #---------------------------------
319 # Collect all tables into a list
320 $sth=$dbh->prepare("show tables");
322 while (my ($table) = $sth->fetchrow) {
323 $existingtables{$table}=1;
326 # Now add any missing tables
327 foreach $table ( keys %requiretables ) {
328 print "Checking $table table...\n" if $debug;
329 unless ($existingtables{$table} ) {
330 print "Adding $table table...\n";
331 my $sth=$dbh->prepare(
332 "create table $table $requiretables{$table}" );
335 print "Error : $sth->errstr \n";
341 # now drop useless tables
342 foreach $table ( keys %dropable_table) {
343 print "Dropping unused tables...\n" if $debug;
344 if ($existingtables{$table} ) {
345 $dbh->do("drop table $table");
347 print "Error : $dbh->errstr \n";
351 unless ($existingtables{'z3950servers'}) {
352 print "Adding z3950servers table...\n";
353 my $sti=$dbh->prepare("create table z3950servers (
364 $sti=$dbh->prepare("insert into z3950servers
365 values ('z3950.loc.gov',
369 'Library of Congress',
374 #---------------------------------
377 foreach $table ( keys %requirefields ) {
378 print "Check table $table\n" if $debug;
379 $sth=$dbh->prepare("show columns from $table");
382 while ( ($column, $type, $null, $key, $default, $extra)
384 $types{$column}=$type;
386 foreach $column ( keys %{ $requirefields{$table} } ) {
387 print " Check column $column\n" if $debug;
388 if ( ! $types{$column} ) {
389 # column doesn't exist
390 print "Adding $column field to $table table...\n";
391 $query="alter table $table
392 add column $column " . $requirefields{$table}->{$column} ;
393 print "Execute: $query\n" if $debug;
394 my $sti=$dbh->prepare($query);
397 print "**Error : $sti->errstr \n";
404 foreach $table ( keys %fielddefinitions ) {
405 print "Check table $table\n" if $debug;
406 $sth=$dbh->prepare("show columns from $table");
409 while ( ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
410 $definitions->{$column}->{type}=$type;
411 $definitions->{$column}->{null}=$null;
412 $definitions->{$column}->{key}=$key;
413 $definitions->{$column}->{default}=$default;
414 $definitions->{$column}->{extra}=$extra;
416 my $fieldrow=$fielddefinitions{$table};
417 foreach my $row ( @$fieldrow ) {
418 my $field = $row->{field};
419 my $type = $row->{type};
420 my $null = $row->{null};
421 my $key = $row->{key};
422 my $default = $row->{default};
423 my $extra = $row->{extra};
424 my $def=$definitions->{$field};
425 unless ($type eq $def->{type} && $null eq $def->{null} && $key eq $def->{key} && $default eq $def->{default} && $extra eq $def->{extra}) {
432 unless ($extra eq 'auto_increment') {
435 my $sth=$dbh->prepare("alter table $table change $field $field $type $null $key $extra default ?");
436 $sth->execute($default);
437 print " Alter $field in $table\n";
442 # Get list of columns from items table
445 $sth=$dbh->prepare("show columns from items");
447 while (my ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
448 $itemtypes{$column}=$type;
451 unless ($itemtypes{'barcode'} eq 'varchar(20)') {
452 $itemtypes{'barcode'}=~/varchar\((\d+)\)/;
455 print "Setting maximum barcode length to 20 (was $oldlength).\n";
456 my $sti=$dbh->prepare("alter table items change barcode barcode varchar(20) not null");
461 # extending the timestamp in branchtransfers...
464 $sth=$dbh->prepare("show columns from branchtransfers");
466 while (my ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
467 $branchtransfers{$column}=$type;
470 unless ($branchtransfers{'datesent'} eq 'datetime') {
471 print "Setting type of datesent in branchtransfers to datetime.\n";
472 my $sti=$dbh->prepare("alter table branchtransfers change datesent datesent datetime");
476 unless ($branchtransfers{'datearrived'} eq 'datetime') {
477 print "Setting type of datearrived in branchtransfers to datetime.\n";
478 my $sti=$dbh->prepare("alter table branchtransfers change datearrived datearrived datetime");
482 # changing the branchcategories table around...
483 my %branchcategories;
485 $sth=$dbh->prepare("show columns from branchcategories");
487 while (my ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
488 $branchcategories{$column}=$type;
491 unless ($branchcategories{'categorycode'} eq 'varchar(4)') {
492 print "Setting type of categorycode in branchcategories to varchar(4),\n and making the primary key.\n";
493 my $sti=$dbh->prepare("alter table branchcategories change categorycode categorycode varchar(4) not null");
495 $sti=$dbh->prepare("alter table branchcategories add primary key (categorycode)");
499 unless ($branchcategories{'categoryname'} eq 'text') {
500 print "Changing branchcode in branchcategories to categoryname text.\n";
501 my $sth=$dbh->prepare("alter table branchcategories change branchcode categoryname text");
505 unless ($branchcategories{'codedescription'} eq 'text') {
506 print "Replacing branchholding in branchcategories with codedescription text.\n";
507 my $sth=$dbh->prepare("alter table branchcategories change branchholding codedescription text");
512 # Populate tables with required data
514 foreach my $table (keys %tabledata) {
515 print "Checking for data required in table $table...\n";
516 my $tablerows=$tabledata{$table};
517 foreach my $row (@$tablerows) {
518 my $uniquefieldrequired=$row->{uniquefieldrequired};
519 my $uniquevalue=$row->{$uniquefieldrequired};
520 my $sth=$dbh->prepare("select $uniquefieldrequired from $table where $uniquefieldrequired=?");
521 $sth->execute($uniquevalue);
522 unless ($sth->rows) {
523 print "Adding row to $table: ";
527 foreach my $field (keys %$row) {
528 (next) if ($field eq 'uniquefieldrequired');
529 my $value=$row->{$field};
530 push @values, $value;
531 print " $field => $value";
532 $fieldlist.="$field,";
537 $placeholders=~s/,$//;
538 my $sth=$dbh->prepare("insert into $table ($fieldlist) values ($placeholders)");
539 $sth->execute(@values);
549 # Revision 1.40 2003/04/22 10:48:27 wolfpac444
550 # Added "father" column to bibliothesaurus table
552 # Revision 1.39 2003/04/04 08:45:00 tipaul
553 # last commits before 1.9.1
555 # Revision 1.38 2003/03/18 10:58:19 tipaul
556 # adding checkdigit parameter that choose how to check the members cardnumber.
558 # * none = no checking
559 # * katipo = checked as before
561 # Revision 1.37 2003/01/30 01:47:48 acli
562 # Corrected syntax error reported by Benedict
564 # Made the indentation somewhat easier to read; the messiness probably caused
565 # the original syntax error.
567 # Revision 1.36 2003/01/28 15:13:30 tipaul
568 # userflag table now created in upgrade script (bugfix #171)
570 # Revision 1.35 2003/01/27 03:12:49 acli
571 # Reworded the description for "acquisitions" to make it fit on the screen
573 # Added "iso" to dateformat, since dateformat is not yet being used anyway
575 # Revision 1.34 2003/01/23 12:30:02 tipaul
576 # introducint marcflavour in systempref file : used for character decoding
578 # Revision 1.33 2003/01/21 09:03:27 tipaul
579 # bugfix (NOTE : this bugs makes installation of the 1.3.3 a little fuzzy. Please fix your DB if you installed 1.3.3)
581 # Revision 1.32 2003/01/16 10:29:45 tipaul
582 # adding a MARC parameter in systempref ( which is ON or OFF)
583 # the search will be a marc search if MARC=ON
584 # and a standard (v1.2) search if MARC=OFF
586 # Revision 1.31 2003/01/06 13:32:43 tipaul
587 # *** empty log message ***
589 # Revision 1.29 2003/01/06 11:14:11 tipaul
590 # last bugfixes before 1.3.3 : systempref table correctly filled
592 # Revision 1.28 2002/12/10 13:27:47 tipaul
593 # bugfixes (davide mails in koha-dev)
595 # Revision 1.27 2002/11/26 15:04:54 tipaul
596 # road to 1.3.2. Updating db structure during installation
598 # Revision 1.26 2002/11/12 17:42:40 tonnesen
599 # Merged some features over from rel-1-2, including primary key checking.
601 # Revision 1.25 2002/11/12 16:44:38 tipaul
604 # * 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)
606 # Revision 1.24 2002/10/30 14:00:23 arensb
607 # (bug fix): Fixed typo.
609 # Revision 1.23 2002/10/25 10:55:46 tipaul
611 # * bugfixes and improvements
612 # * manage mandatory MARC subfields
613 # * 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.
614 # this submit contains everything needed :
617 # * "links" management
618 # * creation of a html-list if a subfield is mapped to an authorised value.
620 # Note this is different from authorities support, which will come soon.
621 # 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...
623 # Revision 1.22 2002/10/15 10:08:19 tipaul
624 # fixme corrected, re-indent and adding the marc_breeding table (see commit of marcimport.pl for more explanations about breeding)
626 # Revision 1.21 2002/10/14 11:48:59 tipaul
629 # Revision 1.20 2002/10/10 04:49:41 arensb
630 # Added some FIXME comments.
632 # Revision 1.19 2002/10/05 10:17:17 arensb
633 # Merged with arensb-context branch: use C4::Context->dbh instead of
634 # &C4Connect, and generally prefer C4::Context over C4::Database.
636 # Revision 1.18.2.2 2002/10/05 06:18:43 arensb
637 # Added a whole mess of FIXME comments.
639 # Revision 1.18.2.1 2002/10/04 02:46:00 arensb
640 # Use C4::Connect instead of C4::Database, C4::Connect->dbh instead
643 # Revision 1.18 2002/09/24 13:50:55 tipaul
644 # long WAS the road to 1.3.0...
645 # coming VERY SOON NOW...
646 # modifying installer and buildrelease to update the DB
648 # Revision 1.17 2002/09/24 12:57:35 tipaul
649 # long WAS the road to 1.3.0...
650 # coming VERY SOON NOW...
651 # modifying installer and buildrelease to update the DB
653 # Revision 1.16 2002/07/31 02:34:27 finlayt
655 # added "notforloan" field to the itemtypes table.
657 # Revision 1.15 2002/07/20 22:30:06 rangi
658 # Making sure fix makes it into the main branch as well
661 # Revision 1.14 2002/07/08 16:20:26 tonnesen
662 # Added sessionqueries table and password/userid fields to borrowers table
664 # Revision 1.13 2002/07/04 18:05:36 tonnesen
667 # Revision 1.12 2002/07/04 16:41:06 tonnesen
668 # Merged changes from rel-1-2. Abstracted table structure changes by alan.