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 '',
109 KEY freelib (freelib),
111 KEY category (category),
112 KEY hierarchy (hierarchy)
115 bibid bigint(20) unsigned NOT NULL auto_increment,
116 biblionumber int(11) NOT NULL default '0',
117 datecreated date NOT NULL default '0000-00-00',
118 datemodified date default NULL,
119 origincode char(20) default NULL,
121 KEY origincode (origincode),
122 KEY biblionumber (biblionumber)
124 marc_blob_subfield => "(
125 blobidlink bigint(20) NOT NULL auto_increment,
126 subfieldvalue longtext NOT NULL,
127 PRIMARY KEY (blobidlink)
129 marc_subfield_structure => "(
130 tagfield char(3) NOT NULL default '',
131 tagsubfield char(1) NOT NULL default '',
132 liblibrarian char(255) NOT NULL default '',
133 libopac char(255) NOT NULL default '',
134 repeatable tinyint(4) NOT NULL default '0',
135 mandatory tinyint(4) NOT NULL default '0',
136 kohafield char(40) default NULL,
137 tab tinyint(1) default NULL,
138 authorised_value char(10) default NULL,
139 thesaurus_category char(10) default NULL,
140 value_builder char(80) default NULL,
141 PRIMARY KEY (tagfield,tagsubfield),
142 KEY kohafield (kohafield),
145 marc_subfield_table => "(
146 subfieldid bigint(20) unsigned NOT NULL auto_increment,
147 bibid bigint(20) unsigned NOT NULL default '0',
148 tag char(3) NOT NULL default '',
149 tagorder tinyint(4) NOT NULL default '1',
150 tag_indicator char(2) NOT NULL default '',
151 subfieldcode char(1) NOT NULL default '',
152 subfieldorder tinyint(4) NOT NULL default '1',
153 subfieldvalue varchar(255) default NULL,
154 valuebloblink bigint(20) default NULL,
155 PRIMARY KEY (subfieldid),
158 KEY tag_indicator (tag_indicator),
159 KEY subfieldorder (subfieldorder),
160 KEY subfieldcode (subfieldcode),
161 KEY subfieldvalue (subfieldvalue),
162 KEY tagorder (tagorder)
164 marc_tag_structure => "(
165 tagfield char(3) NOT NULL default '',
166 liblibrarian char(255) NOT NULL default '',
167 libopac char(255) NOT NULL default '',
168 repeatable tinyint(4) NOT NULL default '0',
169 mandatory tinyint(4) NOT NULL default '0',
170 authorised_value char(10) default NULL,
171 PRIMARY KEY (tagfield)
174 bibid bigint(20) NOT NULL default '0',
175 tag char(3) NOT NULL default '',
176 tagorder tinyint(4) NOT NULL default '1',
177 subfieldid char(1) NOT NULL default '',
178 subfieldorder tinyint(4) NOT NULL default '1',
179 word varchar(255) NOT NULL default '',
180 sndx_word varchar(255) NOT NULL default '',
183 KEY tagorder (tagorder),
184 KEY subfieldid (subfieldid),
185 KEY subfieldorder (subfieldorder),
187 KEY sndx_word (sndx_word)
189 marc_breeding =>"( id bigint(20) NOT NULL auto_increment,
190 file varchar(80) NOT NULL default '',
191 isbn varchar(10) NOT NULL default '',
192 title varchar(128) default NULL,
193 author varchar(80) default NULL,
199 authorised_values => "(id int(11) NOT NULL auto_increment,
200 category char(10) NOT NULL default '',
201 authorised_value char(80) NOT NULL default '',
206 userflags => "( bit int(11) NOT NULL default '0',
207 flag char(30), flagdesc char(255),
215 biblio=>{ 'abstract' => 'text' },
216 deletedbiblio=>{ 'abstract' => 'text' },
217 biblioitems=>{ 'lccn' => 'char(25)',
218 'url' => 'varchar(255)',
220 deletedbiblioitems=>{ 'lccn' => 'char(25)',
221 'url' => 'varchar(255)',
223 branchtransfers=>{ 'datearrived' => 'datetime' },
224 statistics=>{'borrowernumber' =>'int(11)'},
225 aqbooksellers=>{'invoicedisc' =>'float(6,4)',
226 'nocalc' => 'int(11)'},
227 borrowers=>{'userid' => 'char(30)',
228 'password' => 'char(30)',
229 'flags' => 'int(11)'},
230 aqorders=>{'budgetdate' => 'date'},
231 #added so that reference items are not available for reserves...
232 itemtypes=>{'notforloan' => 'smallint(6)'},
233 systempreferences =>{'explanation' => 'char(80)'},
237 classification =>'classification',
238 multipart =>'multipart',
239 multivolume =>'multivolume',
240 newitems =>'newitems',
241 procedures =>'procedures',
242 publisher =>'publisher',
243 searchstats =>'searchstats',
244 serialissues =>'serialissues',
248 # The tabledata hash contains data that should be in the tables.
249 # The uniquefieldrequired hash entry is used to determine which (if any) fields
250 # must not exist in the table for this row to be inserted. If the
251 # uniquefieldrequired entry is already in the table, the existing data is not
256 { uniquefieldrequired => 'bit', bit => 0, flag => 'superlibrarian', flagdesc => 'Access to all librarian functions', defaulton => 0 },
257 { uniquefieldrequired => 'bit', bit => 1, flag => 'circulate', flagdesc => 'Circulate books', defaulton => 0 },
258 { uniquefieldrequired => 'bit', bit => 2, flag => 'catalogue', flagdesc => 'View Catalogue (Librarian Interface)', defaulton => 0 },
259 { uniquefieldrequired => 'bit', bit => 3, flag => 'parameters', flagdesc => 'Set Koha system paramters', defaulton => 0 },
260 { uniquefieldrequired => 'bit', bit => 4, flag => 'borrowers', flagdesc => 'Add or modify borrowers', defaulton => 0 },
261 { uniquefieldrequired => 'bit', bit => 5, flag => 'permissions', flagdesc => 'Set user permissions', defaulton => 0 },
262 { uniquefieldrequired => 'bit', bit => 6, flag => 'reserveforothers', flagdesc => 'Reserve books for patrons', defaulton => 0 },
263 { uniquefieldrequired => 'bit', bit => 7, flag => 'borrow', flagdesc => 'Borrow books', defaulton => 1 },
264 { uniquefieldrequired => 'bit', bit => 8, flag => 'reserveforself', flagdesc => 'Reserve books for self', defaulton => 0 },
265 { uniquefieldrequired => 'bit', bit => 9, flag => 'editcatalogue', flagdesc => 'Edit Catalogue (Modify bibliographic/holdings data)', defaulton => 0 },
266 { uniquefieldrequired => 'bit', bit => 10, flag => 'updatecharges', flagdesc => 'Update borrower charges', defaulton => 0 },
268 systempreferences => [
269 { uniquefieldrequired => 'variable', variable => 'autoMemberNum', value => '1', explanation => '1 or else. If 1, Barcode is auto-calculated' },
270 { uniquefieldrequired => 'variable', variable => 'acquisitions', value => 'simple', explanation => 'normal or simple : whether to use "acqui" or "acqui.simple" acquisition system' },
271 { uniquefieldrequired => 'variable', variable => 'dateformat', value => 'metric', explanation => 'metric, us, or iso' },
272 { uniquefieldrequired => 'variable', variable => 'template', value => 'default', explanation => 'template default name' },
273 { uniquefieldrequired => 'variable', variable => 'autoBarcode', value => '1', explanation => '1 or else. If 1, Barcode is auto-calculated' },
274 { uniquefieldrequired => 'variable', variable => 'insecure', value => 'NO', explanation => 'if YES, no auth at all is needed. Be careful if you set this to yes !' },
275 { uniquefieldrequired => 'variable', variable => 'authoritysep', value => '--', explanation => 'the separator used in authority/thesaurus. Usually --' },
276 { uniquefieldrequired => 'variable', variable => 'opaclanguages', value => 'en', explanation => 'languages' },
277 { uniquefieldrequired => 'variable', variable => 'opacthemes', value => 'default', explanation => 'theme' },
278 { uniquefieldrequired => 'variable', variable => 'timeout', value => '12000000', explanation => 'login timeout' },
279 { uniquefieldrequired => 'variable', variable => 'marc', value => 'ON', explanation => 'MARC support (ON or OFF)' },
280 { uniquefieldrequired => 'variable', variable => 'marcflavour', value => 'MARC21', explanation => 'your MARC flavor (MARC21 or UNIMARC) used for character encoding' },
281 { uniquefieldrequired => 'variable', variable => 'checkdigit', value => 'katipo', explanation => 'none= no check on member cardnumber. katipo= katipo check' },
287 my %fielddefinitions=(
289 { field => 'printername', type => 'char(40)', null => '', key => 'PRI', default => '' },
292 { field => 'bookfundid', type => 'char(5)', null => '', key => 'PRI', default => '' },
295 { field => 'id', type => 'int', null => '', key => 'PRI', default => '', extra => 'auto_increment' },
306 # Get version of MySQL database engine.
307 my $mysqlversion=`mysqld --version`;
308 $mysqlversion=~/Ver (\S*) /;
310 if ($mysqlversion ge '3.23') {
311 print "Could convert to MyISAM database tables...\n";
314 #---------------------------------
317 # Collect all tables into a list
318 $sth=$dbh->prepare("show tables");
320 while (my ($table) = $sth->fetchrow) {
321 $existingtables{$table}=1;
324 # Now add any missing tables
325 foreach $table ( keys %requiretables ) {
326 print "Checking $table table...\n" if $debug;
327 unless ($existingtables{$table} ) {
328 print "Adding $table table...\n";
329 my $sth=$dbh->prepare(
330 "create table $table $requiretables{$table}" );
333 print "Error : $sth->errstr \n";
339 # now drop useless tables
340 foreach $table ( keys %dropable_table) {
341 print "Dropping unused tables...\n" if $debug;
342 if ($existingtables{$table} ) {
343 $dbh->do("drop table $table");
345 print "Error : $dbh->errstr \n";
349 unless ($existingtables{'z3950servers'}) {
350 print "Adding z3950servers table...\n";
351 my $sti=$dbh->prepare("create table z3950servers (
362 $sti=$dbh->prepare("insert into z3950servers
363 values ('z3950.loc.gov',
367 'Library of Congress',
372 #---------------------------------
375 foreach $table ( keys %requirefields ) {
376 print "Check table $table\n" if $debug;
377 $sth=$dbh->prepare("show columns from $table");
380 while ( ($column, $type, $null, $key, $default, $extra)
382 $types{$column}=$type;
384 foreach $column ( keys %{ $requirefields{$table} } ) {
385 print " Check column $column\n" if $debug;
386 if ( ! $types{$column} ) {
387 # column doesn't exist
388 print "Adding $column field to $table table...\n";
389 $query="alter table $table
390 add column $column " . $requirefields{$table}->{$column} ;
391 print "Execute: $query\n" if $debug;
392 my $sti=$dbh->prepare($query);
395 print "**Error : $sti->errstr \n";
402 foreach $table ( keys %fielddefinitions ) {
403 print "Check table $table\n" if $debug;
404 $sth=$dbh->prepare("show columns from $table");
407 while ( ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
408 $definitions->{$column}->{type}=$type;
409 $definitions->{$column}->{null}=$null;
410 $definitions->{$column}->{key}=$key;
411 $definitions->{$column}->{default}=$default;
412 $definitions->{$column}->{extra}=$extra;
414 my $fieldrow=$fielddefinitions{$table};
415 foreach my $row ( @$fieldrow ) {
416 my $field = $row->{field};
417 my $type = $row->{type};
418 my $null = $row->{null};
419 my $key = $row->{key};
420 my $default = $row->{default};
421 my $extra = $row->{extra};
422 my $def=$definitions->{$field};
423 unless ($type eq $def->{type} && $null eq $def->{null} && $key eq $def->{key} && $default eq $def->{default} && $extra eq $def->{extra}) {
430 unless ($extra eq 'auto_increment') {
433 my $sth=$dbh->prepare("alter table $table change $field $field $type $null $key $extra default ?");
434 $sth->execute($default);
435 print " Alter $field in $table\n";
440 # Get list of columns from items table
443 $sth=$dbh->prepare("show columns from items");
445 while (my ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
446 $itemtypes{$column}=$type;
449 unless ($itemtypes{'barcode'} eq 'varchar(20)') {
450 $itemtypes{'barcode'}=~/varchar\((\d+)\)/;
453 print "Setting maximum barcode length to 20 (was $oldlength).\n";
454 my $sti=$dbh->prepare("alter table items change barcode barcode varchar(20) not null");
459 # extending the timestamp in branchtransfers...
462 $sth=$dbh->prepare("show columns from branchtransfers");
464 while (my ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
465 $branchtransfers{$column}=$type;
468 unless ($branchtransfers{'datesent'} eq 'datetime') {
469 print "Setting type of datesent in branchtransfers to datetime.\n";
470 my $sti=$dbh->prepare("alter table branchtransfers change datesent datesent datetime");
474 unless ($branchtransfers{'datearrived'} eq 'datetime') {
475 print "Setting type of datearrived in branchtransfers to datetime.\n";
476 my $sti=$dbh->prepare("alter table branchtransfers change datearrived datearrived datetime");
480 # changing the branchcategories table around...
481 my %branchcategories;
483 $sth=$dbh->prepare("show columns from branchcategories");
485 while (my ($column, $type, $null, $key, $default, $extra) = $sth->fetchrow) {
486 $branchcategories{$column}=$type;
489 unless ($branchcategories{'categorycode'} eq 'varchar(4)') {
490 print "Setting type of categorycode in branchcategories to varchar(4),\n and making the primary key.\n";
491 my $sti=$dbh->prepare("alter table branchcategories change categorycode categorycode varchar(4) not null");
493 $sti=$dbh->prepare("alter table branchcategories add primary key (categorycode)");
497 unless ($branchcategories{'categoryname'} eq 'text') {
498 print "Changing branchcode in branchcategories to categoryname text.\n";
499 my $sth=$dbh->prepare("alter table branchcategories change branchcode categoryname text");
503 unless ($branchcategories{'codedescription'} eq 'text') {
504 print "Replacing branchholding in branchcategories with codedescription text.\n";
505 my $sth=$dbh->prepare("alter table branchcategories change branchholding codedescription text");
510 # Populate tables with required data
512 foreach my $table (keys %tabledata) {
513 print "Checking for data required in table $table...\n";
514 my $tablerows=$tabledata{$table};
515 foreach my $row (@$tablerows) {
516 my $uniquefieldrequired=$row->{uniquefieldrequired};
517 my $uniquevalue=$row->{$uniquefieldrequired};
518 my $sth=$dbh->prepare("select $uniquefieldrequired from $table where $uniquefieldrequired=?");
519 $sth->execute($uniquevalue);
520 unless ($sth->rows) {
521 print "Adding row to $table: ";
525 foreach my $field (keys %$row) {
526 (next) if ($field eq 'uniquefieldrequired');
527 my $value=$row->{$field};
528 push @values, $value;
529 print " $field => $value";
530 $fieldlist.="$field,";
535 $placeholders=~s/,$//;
536 my $sth=$dbh->prepare("insert into $table ($fieldlist) values ($placeholders)");
537 $sth->execute(@values);
547 # Revision 1.38 2003/03/18 10:58:19 tipaul
548 # adding checkdigit parameter that choose how to check the members cardnumber.
550 # * none = no checking
551 # * katipo = checked as before
553 # Revision 1.37 2003/01/30 01:47:48 acli
554 # Corrected syntax error reported by Benedict
556 # Made the indentation somewhat easier to read; the messiness probably caused
557 # the original syntax error.
559 # Revision 1.36 2003/01/28 15:13:30 tipaul
560 # userflag table now created in upgrade script (bugfix #171)
562 # Revision 1.35 2003/01/27 03:12:49 acli
563 # Reworded the description for "acquisitions" to make it fit on the screen
565 # Added "iso" to dateformat, since dateformat is not yet being used anyway
567 # Revision 1.34 2003/01/23 12:30:02 tipaul
568 # introducint marcflavour in systempref file : used for character decoding
570 # Revision 1.33 2003/01/21 09:03:27 tipaul
571 # bugfix (NOTE : this bugs makes installation of the 1.3.3 a little fuzzy. Please fix your DB if you installed 1.3.3)
573 # Revision 1.32 2003/01/16 10:29:45 tipaul
574 # adding a MARC parameter in systempref ( which is ON or OFF)
575 # the search will be a marc search if MARC=ON
576 # and a standard (v1.2) search if MARC=OFF
578 # Revision 1.31 2003/01/06 13:32:43 tipaul
579 # *** empty log message ***
581 # Revision 1.29 2003/01/06 11:14:11 tipaul
582 # last bugfixes before 1.3.3 : systempref table correctly filled
584 # Revision 1.28 2002/12/10 13:27:47 tipaul
585 # bugfixes (davide mails in koha-dev)
587 # Revision 1.27 2002/11/26 15:04:54 tipaul
588 # road to 1.3.2. Updating db structure during installation
590 # Revision 1.26 2002/11/12 17:42:40 tonnesen
591 # Merged some features over from rel-1-2, including primary key checking.
593 # Revision 1.25 2002/11/12 16:44:38 tipaul
596 # * 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)
598 # Revision 1.24 2002/10/30 14:00:23 arensb
599 # (bug fix): Fixed typo.
601 # Revision 1.23 2002/10/25 10:55:46 tipaul
603 # * bugfixes and improvements
604 # * manage mandatory MARC subfields
605 # * 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.
606 # this submit contains everything needed :
609 # * "links" management
610 # * creation of a html-list if a subfield is mapped to an authorised value.
612 # Note this is different from authorities support, which will come soon.
613 # 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...
615 # Revision 1.22 2002/10/15 10:08:19 tipaul
616 # fixme corrected, re-indent and adding the marc_breeding table (see commit of marcimport.pl for more explanations about breeding)
618 # Revision 1.21 2002/10/14 11:48:59 tipaul
621 # Revision 1.20 2002/10/10 04:49:41 arensb
622 # Added some FIXME comments.
624 # Revision 1.19 2002/10/05 10:17:17 arensb
625 # Merged with arensb-context branch: use C4::Context->dbh instead of
626 # &C4Connect, and generally prefer C4::Context over C4::Database.
628 # Revision 1.18.2.2 2002/10/05 06:18:43 arensb
629 # Added a whole mess of FIXME comments.
631 # Revision 1.18.2.1 2002/10/04 02:46:00 arensb
632 # Use C4::Connect instead of C4::Database, C4::Connect->dbh instead
635 # Revision 1.18 2002/09/24 13:50:55 tipaul
636 # long WAS the road to 1.3.0...
637 # coming VERY SOON NOW...
638 # modifying installer and buildrelease to update the DB
640 # Revision 1.17 2002/09/24 12:57:35 tipaul
641 # long WAS the road to 1.3.0...
642 # coming VERY SOON NOW...
643 # modifying installer and buildrelease to update the DB
645 # Revision 1.16 2002/07/31 02:34:27 finlayt
647 # added "notforloan" field to the itemtypes table.
649 # Revision 1.15 2002/07/20 22:30:06 rangi
650 # Making sure fix makes it into the main branch as well
653 # Revision 1.14 2002/07/08 16:20:26 tonnesen
654 # Added sessionqueries table and password/userid fields to borrowers table
656 # Revision 1.13 2002/07/04 18:05:36 tonnesen
659 # Revision 1.12 2002/07/04 16:41:06 tonnesen
660 # Merged changes from rel-1-2. Abstracted table structure changes by alan.