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.
24 use MARC::File::XML ( BinaryEncoding => 'utf8' );
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
46 my $dbh = C4::Context->dbh;
47 print "connected to your DB. Checking & modifying it\n" unless $silent;
48 $|=1; # flushes output
53 # Tables to add if they don't exist
55 categorytable => "(categorycode char(5) NOT NULL default '',
56 description text default '',
57 itemtypecodes text default '',
58 PRIMARY KEY (categorycode)
60 subcategorytable => "(subcategorycode char(5) NOT NULL default '',
61 description text default '',
62 itemtypecodes text default '',
63 PRIMARY KEY (subcategorycode)
65 mediatypetable => "(mediatypecode char(5) NOT NULL default '',
66 description text default '',
67 itemtypecodes text default '',
68 PRIMARY KEY (mediatypecode)
71 `timestamp` TIMESTAMP NOT NULL ,
72 `user` INT( 11 ) NOT NULL ,
73 `module` TEXT default '',
74 `action` TEXT default '' ,
75 `object` INT(11) default '' ,
76 `info` TEXT default '' ,
77 PRIMARY KEY ( `timestamp` , `user` )
80 module varchar(20) NOT NULL default '',
81 code varchar(20) NOT NULL default '',
82 name varchar(100) NOT NULL default '',
83 title varchar(200) NOT NULL default '',
85 PRIMARY KEY (module,code)
88 alertid int(11) NOT NULL auto_increment,
89 borrowernumber int(11) NOT NULL default '0',
90 type varchar(10) NOT NULL default '',
91 externalid varchar(20) NOT NULL default '',
92 PRIMARY KEY (alertid),
93 KEY borrowernumber (borrowernumber),
94 KEY type (type,externalid)
97 `idnew` int(10) unsigned NOT NULL auto_increment,
98 `title` varchar(250) NOT NULL default '',
100 `lang` varchar(4) NOT NULL default '',
101 `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP,
102 PRIMARY KEY (`idnew`)
104 repeatable_holidays => "(
105 `id` int(11) NOT NULL auto_increment,
106 `branchcode` varchar(4) NOT NULL default '',
107 `weekday` smallint(6) default NULL,
108 `day` smallint(6) default NULL,
109 `month` smallint(6) default NULL,
110 `title` varchar(50) NOT NULL default '',
111 `description` text NOT NULL,
114 special_holidays => "(
115 `id` int(11) NOT NULL auto_increment,
116 `branchcode` varchar(4) NOT NULL default '',
117 `day` smallint(6) NOT NULL default '0',
118 `month` smallint(6) NOT NULL default '0',
119 `year` smallint(6) NOT NULL default '0',
120 `isexception` smallint(1) NOT NULL default '1',
121 `title` varchar(50) NOT NULL default '',
122 `description` text NOT NULL,
125 overduerules =>"(`branchcode` varchar(255) NOT NULL default '',
126 `categorycode` char(2) NOT NULL default '',
127 `delay1` int(4) default '0',
128 `letter1` varchar(20) default NULL,
129 `debarred1` char(1) default '0',
130 `delay2` int(4) default '0',
131 `debarred2` char(1) default '0',
132 `letter2` varchar(20) default NULL,
133 `delay3` int(4) default '0',
134 `letter3` varchar(20) default NULL,
135 `debarred3` int(1) default '0',
136 PRIMARY KEY (`branchcode`,`categorycode`)
140 my %requirefields = (
141 subscription => { 'letter' => 'char(20) NULL', 'distributedto' => 'text NULL'},
142 itemtypes => { 'imageurl' => 'char(200) NULL'},
143 aqbookfund => { 'branchcode' => 'varchar(4) NULL'},
144 # tablename => { 'field' => 'fieldtype' },
147 my %dropable_table = (
148 sessionqueries => 'sessionqueries',
149 marcrecorddone => 'marcrecorddone',
151 itemsprices => 'itemsprices',
152 biblioanalysis => 'biblioanalysis',
154 # tablename => 'tablename',
157 my %uselessfields = (
158 # tablename => "field1,field2",
160 # the other hash contains other actions that can't be done elsewhere. they are done
161 # either BEFORE of AFTER everything else, depending on "when" entry (default => AFTER)
163 # The tabledata hash contains data that should be in the tables.
164 # The uniquefieldrequired hash entry is used to determine which (if any) fields
165 # must not exist in the table for this row to be inserted. If the
166 # uniquefieldrequired entry is already in the table, the existing data is not
167 # modified, unless the forceupdate hash entry is also set. Fields in the
168 # anonymous "forceupdate" hash will be forced to be updated to the default
169 # values given in the %tabledata hash.
173 # { uniquefielrequired => 'fieldname', # the primary key in the table
174 # fieldname => fieldvalue,
175 # fieldname2 => fieldvalue2,
178 systempreferences => [
180 uniquefieldrequired => 'variable',
181 variable => 'Activate_Log',
183 forceupdate => { 'explanation' => 1,
185 explanation => 'Turn Log Actions on DB On an Off',
189 uniquefieldrequired => 'variable',
190 variable => 'IndependantBranches',
192 forceupdate => { 'explanation' => 1,
194 explanation => 'Turn Branch independancy management On an Off',
198 uniquefieldrequired => 'variable',
199 variable => 'ReturnBeforeExpiry',
201 forceupdate => { 'explanation' => 1,
203 explanation => 'If Yes, Returndate on issuing can\'t be after borrower card expiry',
207 uniquefieldrequired => 'variable',
208 variable => 'opacstylesheet',
210 forceupdate => { 'explanation' => 1,
212 explanation => 'Enter a complete URL to use an alternate stylesheet in OPAC',
216 uniquefieldrequired => 'variable',
217 variable => 'opacsmallimage',
219 forceupdate => { 'explanation' => 1,
221 explanation => 'Enter a complete URL to an image, will be on top/left instead of the Koha logo',
225 uniquefieldrequired => 'variable',
226 variable => 'opaclargeimage',
228 forceupdate => { 'explanation' => 1,
230 explanation => 'Enter a complete URL to an image, will be on the main page, instead of the Koha logo',
234 uniquefieldrequired => 'variable',
235 variable => 'delimiter',
237 forceupdate => { 'explanation' => 1,
239 explanation => 'separator for reports exported to spreadsheet',
243 uniquefieldrequired => 'variable',
245 value => 'OPENOFFICE.ORG',
246 forceupdate => { 'explanation' => 1,
249 explanation => 'Define the default application for report exportations into files',
251 options => 'EXCEL|OPENOFFICE.ORG'
254 uniquefieldrequired => 'variable',
255 variable => 'Delimiter',
257 forceupdate => { 'explanation' => 1,
260 explanation => 'Define the default separator character for report exportations into files',
262 options => ';|tabulation|,|/|\|#'
265 uniquefieldrequired => 'variable',
266 variable => 'SubscriptionHistory',
268 forceupdate => { 'explanation' => 1,
271 explanation => 'Define the information level for serials history in OPAC',
273 options => 'simplified|full'
276 uniquefieldrequired => 'variable',
277 variable => 'hidelostitems',
279 forceupdate => { 'explanation' => 1,
281 explanation => 'show or hide "lost" items in OPAC.',
285 uniquefieldrequired => 'variable',
286 variable => 'IndependantBranches',
288 forceupdate => { 'explanation' => 1,
290 explanation => 'Turn Branch independancy management On an Off',
294 uniquefieldrequired => 'variable',
295 variable => 'ReturnBeforeExpiry',
297 forceupdate => { 'explanation' => 1,
299 explanation => 'If Yes, Returndate on issuing can\'t be after borrower card expiry',
303 uniquefieldrequired => 'variable',
304 variable => 'Disable_Dictionary',
306 forceupdate => { 'explanation' => 1,
308 explanation => 'Disables Dictionary buttons if set to yes',
312 uniquefieldrequired => 'variable',
313 variable => 'hide_marc',
315 forceupdate => { 'explanation' => 1,
317 explanation => 'hide marc specific datas like subfield code & indicators to library',
321 uniquefieldrequired => 'variable',
322 variable => 'NotifyBorrowerDeparture',
324 forceupdate => { 'explanation' => 1,
326 explanation => 'Delay before expiry where a notice is sent when issuing',
330 uniquefieldrequired => 'variable',
331 variable => 'OpacPasswordChange',
333 forceupdate => { 'explanation' => 1,
335 explanation => 'Enable/Disable password change in OPAC (disable it when using LDAP auth)',
339 uniquefieldrequired => 'variable',
340 variable => 'useDaysMode',
342 forceupdate => { 'explanation' => 1,
344 explanation => 'How to calculate return dates : Calendar means holidays will be controled, Days means the return date don\'t depend on holidays',
346 options => 'Calendar|Days'
352 my %fielddefinitions = (
354 # { field => 'fieldname',
355 # type => 'fieldtype',
373 field => 'booksellerid',
383 field => 'listprice',
384 type => 'varchar(10)',
391 field => 'invoiceprice',
392 type => 'varchar(10)',
401 field => 'borrowernumber',
403 null => 'NULL', # can be null when a borrower is deleted and the foreign key rule executed
409 field => 'itemnumber',
411 null => 'NULL', # can be null when a borrower is deleted and the foreign key rule executed
421 # { indexname => 'index detail'
425 { indexname => 'shelfnumber',
426 content => 'shelfnumber',
428 { indexname => 'itemnumber',
429 content => 'itemnumber',
433 { indexname => 'biblionumber',
434 content => 'biblionumber',
438 { indexname => 'homebranch',
439 content => 'homebranch',
441 { indexname => 'holdingbranch',
442 content => 'holdingbranch',
446 { indexname => 'PRIMARY',
452 { indexname => 'booksellerid',
453 content => 'booksellerid',
457 { indexname => 'basketno',
458 content => 'basketno',
461 aqorderbreakdown => [
462 { indexname => 'ordernumber',
463 content => 'ordernumber',
465 { indexname => 'bookfundid',
466 content => 'bookfundid',
470 { indexname => 'PRIMARY',
471 content => 'currency',
479 # { key => 'the key in table' (must be indexed)
480 # foreigntable => 'the foreigntable name', # (the parent)
481 # foreignkey => 'the foreign key column(s)' # (in the parent)
482 # onUpdate => 'CASCADE|SET NULL|NO ACTION| RESTRICT',
483 # onDelete => 'CASCADE|SET NULL|NO ACTION| RESTRICT',
487 { key => 'shelfnumber',
488 foreigntable => 'bookshelf',
489 foreignkey => 'shelfnumber',
490 onUpdate => 'CASCADE',
491 onDelete => 'CASCADE',
493 { key => 'itemnumber',
494 foreigntable => 'items',
495 foreignkey => 'itemnumber',
496 onUpdate => 'CASCADE',
497 onDelete => 'CASCADE',
500 # onDelete is RESTRICT on reference tables (branches, itemtype) as we don't want items to be
501 # easily deleted, but branches/itemtype not too easy to empty...
503 { key => 'biblionumber',
504 foreigntable => 'biblio',
505 foreignkey => 'biblionumber',
506 onUpdate => 'CASCADE',
507 onDelete => 'CASCADE',
510 foreigntable => 'itemtypes',
511 foreignkey => 'itemtype',
512 onUpdate => 'CASCADE',
513 onDelete => 'RESTRICT',
517 { key => 'biblioitemnumber',
518 foreigntable => 'biblioitems',
519 foreignkey => 'biblioitemnumber',
520 onUpdate => 'CASCADE',
521 onDelete => 'CASCADE',
523 { key => 'homebranch',
524 foreigntable => 'branches',
525 foreignkey => 'branchcode',
526 onUpdate => 'CASCADE',
527 onDelete => 'RESTRICT',
529 { key => 'holdingbranch',
530 foreigntable => 'branches',
531 foreignkey => 'branchcode',
532 onUpdate => 'CASCADE',
533 onDelete => 'RESTRICT',
536 additionalauthors => [
537 { key => 'biblionumber',
538 foreigntable => 'biblio',
539 foreignkey => 'biblionumber',
540 onUpdate => 'CASCADE',
541 onDelete => 'CASCADE',
545 { key => 'biblionumber',
546 foreigntable => 'biblio',
547 foreignkey => 'biblionumber',
548 onUpdate => 'CASCADE',
549 onDelete => 'CASCADE',
553 { key => 'booksellerid',
554 foreigntable => 'aqbooksellers',
556 onUpdate => 'CASCADE',
557 onDelete => 'RESTRICT',
562 foreigntable => 'aqbasket',
563 foreignkey => 'basketno',
564 onUpdate => 'CASCADE',
565 onDelete => 'CASCADE',
567 { key => 'biblionumber',
568 foreigntable => 'biblio',
569 foreignkey => 'biblionumber',
570 onUpdate => 'SET NULL',
571 onDelete => 'SET NULL',
575 { key => 'listprice',
576 foreigntable => 'currency',
577 foreignkey => 'currency',
578 onUpdate => 'CASCADE',
579 onDelete => 'CASCADE',
581 { key => 'invoiceprice',
582 foreigntable => 'currency',
583 foreignkey => 'currency',
584 onUpdate => 'CASCADE',
585 onDelete => 'CASCADE',
588 aqorderbreakdown => [
589 { key => 'ordernumber',
590 foreigntable => 'aqorders',
591 foreignkey => 'ordernumber',
592 onUpdate => 'CASCADE',
593 onDelete => 'CASCADE',
595 { key => 'bookfundid',
596 foreigntable => 'aqbookfund',
597 foreignkey => 'bookfundid',
598 onUpdate => 'CASCADE',
599 onDelete => 'CASCADE',
603 { key => 'frombranch',
604 foreigntable => 'branches',
605 foreignkey => 'branchcode',
606 onUpdate => 'CASCADE',
607 onDelete => 'CASCADE',
610 foreigntable => 'branches',
611 foreignkey => 'branchcode',
612 onUpdate => 'CASCADE',
613 onDelete => 'CASCADE',
615 { key => 'itemnumber',
616 foreigntable => 'items',
617 foreignkey => 'itemnumber',
618 onUpdate => 'CASCADE',
619 onDelete => 'CASCADE',
623 { key => 'categorycode',
624 foreigntable => 'categories',
625 foreignkey => 'categorycode',
626 onUpdate => 'CASCADE',
627 onDelete => 'CASCADE',
630 foreigntable => 'itemtypes',
631 foreignkey => 'itemtype',
632 onUpdate => 'CASCADE',
633 onDelete => 'CASCADE',
636 issues => [ # constraint is SET NULL : when a borrower or an item is deleted, we keep the issuing record
638 { key => 'borrowernumber',
639 foreigntable => 'borrowers',
640 foreignkey => 'borrowernumber',
641 onUpdate => 'SET NULL',
642 onDelete => 'SET NULL',
644 { key => 'itemnumber',
645 foreigntable => 'items',
646 foreignkey => 'itemnumber',
647 onUpdate => 'SET NULL',
648 onDelete => 'SET NULL',
652 { key => 'borrowernumber',
653 foreigntable => 'borrowers',
654 foreignkey => 'borrowernumber',
655 onUpdate => 'CASCADE',
656 onDelete => 'CASCADE',
658 { key => 'biblionumber',
659 foreigntable => 'biblio',
660 foreignkey => 'biblionumber',
661 onUpdate => 'CASCADE',
662 onDelete => 'CASCADE',
664 { key => 'itemnumber',
665 foreigntable => 'items',
666 foreignkey => 'itemnumber',
667 onUpdate => 'CASCADE',
668 onDelete => 'CASCADE',
670 { key => 'branchcode',
671 foreigntable => 'branches',
672 foreignkey => 'branchcode',
673 onUpdate => 'CASCADE',
674 onDelete => 'CASCADE',
677 borrowers => [ # foreign keys are RESTRICT as we don't want to delete borrowers when a branch is deleted
678 # but prevent deleting a branch as soon as it has 1 borrower !
679 { key => 'categorycode',
680 foreigntable => 'categories',
681 foreignkey => 'categorycode',
682 onUpdate => 'RESTRICT',
683 onDelete => 'RESTRICT',
685 { key => 'branchcode',
686 foreigntable => 'branches',
687 foreignkey => 'branchcode',
688 onUpdate => 'RESTRICT',
689 onDelete => 'RESTRICT',
693 { key => 'borrowernumber',
694 foreigntable => 'borrowers',
695 foreignkey => 'borrowernumber',
696 onUpdate => 'CASCADE',
697 onDelete => 'CASCADE',
699 { key => 'itemnumber',
700 foreigntable => 'items',
701 foreignkey => 'itemnumber',
702 onUpdate => 'SET NULL',
703 onDelete => 'SET NULL',
706 auth_tag_structure => [
707 { key => 'authtypecode',
708 foreigntable => 'auth_types',
709 foreignkey => 'authtypecode',
710 onUpdate => 'CASCADE',
711 onDelete => 'CASCADE',
714 # FIXME : don't constraint auth_*_table and auth_word, as they may be replaced by zebra
722 # Get version of MySQL database engine.
723 my $mysqlversion = `mysqld --version`;
724 $mysqlversion =~ /Ver (\S*) /;
726 if ( $mysqlversion ge '3.23' ) {
727 print "Could convert to MyISAM database tables...\n" unless $silent;
730 #---------------------------------
733 # Collect all tables into a list
734 $sth = $dbh->prepare("show tables");
736 while ( my ($table) = $sth->fetchrow ) {
737 $existingtables{$table} = 1;
741 # Now add any missing tables
742 foreach $table ( keys %requiretables ) {
743 unless ( $existingtables{$table} ) {
744 print "Adding $table table...\n" unless $silent;
745 my $sth = $dbh->prepare("create table $table $requiretables{$table}");
748 print "Error : $sth->errstr \n";
754 # now drop useless tables
755 foreach $table ( keys %dropable_table ) {
756 if ( $existingtables{$table} ) {
757 print "Dropping unused table $table\n" if $debug and not $silent;
758 $dbh->do("drop table $table");
760 print "Error : $dbh->errstr \n";
765 #---------------------------------
768 foreach $table ( keys %requirefields ) {
769 print "Check table $table\n" if $debug and not $silent;
770 $sth = $dbh->prepare("show columns from $table");
773 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
775 $types{$column} = $type;
777 foreach $column ( keys %{ $requirefields{$table} } ) {
778 print " Check column $column [$types{$column}]\n" if $debug and not $silent;
779 if ( !$types{$column} ) {
781 # column doesn't exist
782 print "Adding $column field to $table table...\n" unless $silent;
783 $query = "alter table $table
784 add column $column " . $requirefields{$table}->{$column};
785 print "Execute: $query\n" if $debug;
786 my $sti = $dbh->prepare($query);
789 print "**Error : $sti->errstr \n";
796 foreach $table ( keys %fielddefinitions ) {
797 print "Check table $table\n" if $debug;
798 $sth = $dbh->prepare("show columns from $table");
801 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
803 $definitions->{$column}->{type} = $type;
804 $definitions->{$column}->{null} = $null;
805 $definitions->{$column}->{null} = 'NULL' if $null eq 'YES';
806 $definitions->{$column}->{key} = $key;
807 $definitions->{$column}->{default} = $default;
808 $definitions->{$column}->{extra} = $extra;
810 my $fieldrow = $fielddefinitions{$table};
811 foreach my $row (@$fieldrow) {
812 my $field = $row->{field};
813 my $type = $row->{type};
814 my $null = $row->{null};
815 # $null = 'YES' if $row->{null} eq 'NULL';
816 my $key = $row->{key};
817 my $default = $row->{default};
818 my $null = $row->{null};
819 # $default="''" unless $default;
820 my $extra = $row->{extra};
821 my $def = $definitions->{$field};
823 unless ( $type eq $def->{type}
824 && $null eq $def->{null}
825 && $key eq $def->{key}
826 && $extra eq $def->{extra} )
831 if ( $key eq 'PRI' ) {
832 $key = 'PRIMARY KEY';
834 unless ( $extra eq 'auto_increment' ) {
838 # if it's a new column use "add", if it's an old one, use "change".
840 if ($definitions->{$field}->{type}) {
841 $action="change $field"
845 # if it's a primary key, drop the previous pk, before altering the table
847 if ($key ne 'PRIMARY KEY') {
848 $sth =$dbh->prepare("alter table $table $action $field $type $null $key $extra default ?");
850 $sth =$dbh->prepare("alter table $table drop primary key, $action $field $type $null $key $extra default ?");
852 $sth->execute($default);
853 print " Alter $field in $table\n" unless $silent;
859 # Populate tables with required data
862 # synch table and deletedtable.
863 foreach my $table (('borrowers','items','biblio','biblioitems')) {
864 my %deletedborrowers;
865 print "synch'ing $table\n";
866 $sth = $dbh->prepare("show columns from deleted$table");
868 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow ) {
869 $deletedborrowers{$column}=1;
871 $sth = $dbh->prepare("show columns from $table");
874 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow ) {
875 unless ($deletedborrowers{$column}) {
876 my $newcol="alter table deleted$table add $column $type";
877 if ($null eq 'YES') {
880 $newcol .= " NOT NULL ";
882 $newcol .= "default $default" if $default;
883 $newcol .= " after $previous" if $previous;
885 print "creating column $column\n";
891 foreach my $table ( keys %tabledata ) {
892 print "Checking for data required in table $table...\n" unless $silent;
893 my $tablerows = $tabledata{$table};
894 foreach my $row (@$tablerows) {
895 my $uniquefieldrequired = $row->{uniquefieldrequired};
896 my $uniquevalue = $row->{$uniquefieldrequired};
897 my $forceupdate = $row->{forceupdate};
900 "select $uniquefieldrequired from $table where $uniquefieldrequired=?"
902 $sth->execute($uniquevalue);
904 foreach my $field (keys %$forceupdate) {
905 if ($forceupdate->{$field}) {
906 my $sth=$dbh->prepare("update systempreferences set $field=? where $uniquefieldrequired=?");
907 $sth->execute($row->{$field}, $uniquevalue);
911 print "Adding row to $table: " unless $silent;
915 foreach my $field ( keys %$row ) {
916 next if $field eq 'uniquefieldrequired';
917 next if $field eq 'forceupdate';
918 my $value = $row->{$field};
919 push @values, $value;
920 print " $field => $value" unless $silent;
921 $fieldlist .= "$field,";
922 $placeholders .= "?,";
924 print "\n" unless $silent;
925 $fieldlist =~ s/,$//;
926 $placeholders =~ s/,$//;
929 "insert into $table ($fieldlist) values ($placeholders)");
930 $sth->execute(@values);
936 # check indexes and create them when needed
938 print "Checking for index required...\n" unless $silent;
939 foreach my $table ( keys %indexes ) {
941 # read all indexes from $table
943 $sth = $dbh->prepare("show index from $table");
946 while ( my ( $table, $non_unique, $key_name, $Seq_in_index, $Column_name, $Collation, $cardinality, $sub_part, $Packed, $comment ) = $sth->fetchrow ) {
947 $existingindexes{$key_name} = 1;
949 # read indexes to check
950 my $tablerows = $indexes{$table};
951 foreach my $row (@$tablerows) {
952 my $key_name=$row->{indexname};
953 if ($existingindexes{$key_name} eq 1) {
954 # print "$key_name existing";
956 print "\tCreating index $key_name in $table\n";
958 if ($row->{indexname} eq 'PRIMARY') {
959 $sql = "alter table $table ADD PRIMARY KEY ($row->{content})";
961 $sql = "alter table $table ADD INDEX $key_name ($row->{content}) $row->{type}";
964 print "Error $sql : $dbh->err \n" if $dbh->err;
970 # check foreign keys and create them when needed
972 print "Checking for foreign keys required...\n" unless $silent;
973 foreach my $table ( keys %foreign_keys ) {
975 # read all indexes from $table
977 $sth = $dbh->prepare("show table status like '$table'");
979 my $stat = $sth->fetchrow_hashref;
980 # read indexes to check
981 my $tablerows = $foreign_keys{$table};
982 foreach my $row (@$tablerows) {
983 my $foreign_table=$row->{foreigntable};
984 if ($stat->{'Comment'} =~/$foreign_table/) {
985 # print "$foreign_table existing\n";
987 print "\tCreating foreign key $foreign_table in $table\n";
988 # first, drop any orphan value in child table
989 if ($row->{onDelete} ne "RESTRICT") {
990 my $sql = "delete from $table where $row->{key} not in (select $row->{foreignkey} from $row->{foreigntable})";
992 print "SQL ERROR: $sql : $dbh->err \n" if $dbh->err;
994 my $sql="alter table $table ADD FOREIGN KEY $row->{key} ($row->{key}) REFERENCES $row->{foreigntable} ($row->{foreignkey})";
995 $sql .= " on update ".$row->{onUpdate} if $row->{onUpdate};
996 $sql .= " on delete ".$row->{onDelete} if $row->{onDelete};
999 print "====================
1000 An error occured during :
1002 It probably means there is something wrong in your DB : a row ($table.$row->{key}) refers to a value in $row->{foreigntable}.$row->{foreignkey} that does not exist. solve the problem and run updater again (or just the previous SQL statement).
1003 You can find those values with select
1004 \t$table.* from $table where $row->{key} not in (select $row->{foreignkey} from $row->{foreigntable})
1005 ====================\n
1016 # create frameworkcode row in biblio table & fill it with marc_biblio.frameworkcode.
1019 # 1st, get how many biblio we will have to do...
1020 $sth = $dbh->prepare('select count(*) from marc_biblio');
1022 my ($totaltodo) = $sth->fetchrow;
1024 $sth = $dbh->prepare("show columns from biblio");
1027 my $bibliofwexist=0;
1028 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow ){
1029 $bibliofwexist=1 if $column eq 'frameworkcode';
1031 unless ($bibliofwexist) {
1032 print "moving biblioframework to biblio table\n";
1033 $dbh->do('ALTER TABLE `biblio` ADD `frameworkcode` VARCHAR( 4 ) NOT NULL AFTER `biblionumber`');
1034 $sth = $dbh->prepare('select biblionumber,frameworkcode from marc_biblio');
1036 my $sth_update = $dbh->prepare('update biblio set frameworkcode=? where biblionumber=?');
1038 while (my ($biblionumber,$frameworkcode) = $sth->fetchrow) {
1039 $sth_update->execute($frameworkcode,$biblionumber);
1041 print "\r$totaldone / $totaltodo" unless ($totaldone % 100);
1047 # moving MARC data from marc_subfield_table to biblioitems.marc
1049 $sth = $dbh->prepare("show columns from biblioitems");
1053 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow ){
1054 $marcdone=1 if ($type eq 'blob' && $column eq 'marc') ;
1056 unless ($marcdone) {
1057 print "moving MARC record to biblioitems table\n";
1058 # changing marc field type
1059 $dbh->do('ALTER TABLE `biblioitems` CHANGE `marc` `marc` BLOB NULL DEFAULT NULL ');
1060 # adding marc xml, just for convenience
1061 $dbh->do('ALTER TABLE `biblioitems` ADD `marcxml` TEXT CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL ');
1062 # moving data from marc_subfield_value to biblio
1063 $sth = $dbh->prepare('select bibid,biblionumber from marc_biblio');
1065 my $sth_update = $dbh->prepare('update biblioitems set marc=?, marcxml=? where biblionumber=?');
1067 while (my ($bibid,$biblionumber) = $sth->fetchrow) {
1068 my $record = MARCgetbiblio($dbh,$bibid);
1069 print $record->as_formatted if ($biblionumber==3902);
1070 $sth_update->execute($record->as_usmarc(),$record->as_xml(),$biblionumber);
1072 print "\r$totaldone / $totaltodo" unless ($totaldone % 100);
1078 # at last, remove useless fields
1079 foreach $table ( keys %uselessfields ) {
1080 my @fields = split /,/,$uselessfields{$table};
1083 foreach my $fieldtodrop (@fields) {
1084 $fieldtodrop =~ s/\t//g;
1085 $fieldtodrop =~ s/\n//g;
1087 $sth = $dbh->prepare("show columns from $table");
1089 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1091 $exists =1 if ($column eq $fieldtodrop);
1094 print "deleting $fieldtodrop field in $table...\n" unless $silent;
1095 my $sth = $dbh->prepare("alter table $table drop $fieldtodrop");
1102 # MOVE all tables TO UTF-8 and innoDB
1103 $sth = $dbh->prepare("show table status");
1105 while ( my $table = $sth->fetchrow_hashref ) {
1106 # if ($table->{Engine} ne 'InnoDB') {
1107 # $dbh->do("ALTER TABLE $table->{Name} TYPE = innodb");
1108 # print "moving $table->{Name} to InnoDB\n";
1110 unless ($table->{Collation} =~ /^utf8/) {
1111 $dbh->do("ALTER TABLE $table->{Name} CONVERT TO CHARACTER SET utf8");
1112 $dbh->do("ALTER TABLE $table->{Name} DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci");
1113 # FIXME : maybe a ALTER TABLE tbl_name CONVERT TO CHARACTER SET utf8 would be better, def char set seems to work fine. If any problem encountered, let's try with convert !
1114 print "moving $table->{Name} to utf8\n";
1122 # those 2 subs are a copy of Biblio.pm, version 2.2.4
1123 # they are useful only once, for moving from 2.2 to 3.0
1124 # the MARCgetbiblio & MARCgetitem subs in Biblio.pm
1125 # are still here, but uses other tables
1126 # (the ones that are filled by updatedatabase !)
1131 # Returns MARC::Record of the biblio passed in parameter.
1132 my ( $dbh, $bibid ) = @_;
1133 my $record = MARC::Record->new();
1138 "select bibid,subfieldid,tag,tagorder,tag_indicator,subfieldcode,subfieldorder,subfieldvalue,valuebloblink
1139 from marc_subfield_table
1140 where bibid=? order by tag,tagorder,subfieldorder
1145 "select subfieldvalue from marc_blob_subfield where blobidlink=?");
1146 $sth->execute($bibid);
1147 my $prevtagorder = 1;
1148 my $prevtag = 'XXX';
1150 my $field; # for >=10 tags
1151 my $prevvalue; # for <10 tags
1152 while ( my $row = $sth->fetchrow_hashref ) {
1154 if ( $row->{'valuebloblink'} ) { #---- search blob if there is one
1155 $sth2->execute( $row->{'valuebloblink'} );
1156 my $row2 = $sth2->fetchrow_hashref;
1158 $row->{'subfieldvalue'} = $row2->{'subfieldvalue'};
1160 if ( $row->{tagorder} ne $prevtagorder || $row->{tag} ne $prevtag ) {
1161 $previndicator .= " ";
1162 if ( $prevtag < 10 ) {
1163 if ($prevtag ne '000') {
1164 $record->add_fields( ( sprintf "%03s", $prevtag ), $prevvalue ) unless $prevtag eq "XXX"; # ignore the 1st loop
1166 $record->leader(sprintf("%24s",$prevvalue));
1170 $record->add_fields($field) unless $prevtag eq "XXX";
1173 $prevtagorder = $row->{tagorder};
1174 $prevtag = $row->{tag};
1175 $previndicator = $row->{tag_indicator};
1176 if ( $row->{tag} < 10 ) {
1177 $prevvalue = $row->{subfieldvalue};
1180 $field = MARC::Field->new(
1181 ( sprintf "%03s", $prevtag ),
1182 substr( $row->{tag_indicator} . ' ', 0, 1 ),
1183 substr( $row->{tag_indicator} . ' ', 1, 1 ),
1184 $row->{'subfieldcode'},
1185 $row->{'subfieldvalue'}
1190 if ( $row->{tag} < 10 ) {
1191 $record->add_fields( ( sprintf "%03s", $row->{tag} ),
1192 $row->{'subfieldvalue'} );
1195 $field->add_subfields( $row->{'subfieldcode'},
1196 $row->{'subfieldvalue'} );
1198 $prevtag = $row->{tag};
1199 $previndicator = $row->{tag_indicator};
1203 # the last has not been included inside the loop... do it now !
1204 if ( $prevtag ne "XXX" )
1205 { # check that we have found something. Otherwise, prevtag is still XXX and we
1206 # must return an empty record, not make MARC::Record fail because we try to
1207 # create a record with XXX as field :-(
1208 if ( $prevtag < 10 ) {
1209 $record->add_fields( $prevtag, $prevvalue );
1213 # my $field = MARC::Field->new( $prevtag, "", "", %subfieldlist);
1214 $record->add_fields($field);
1222 # Returns MARC::Record of the biblio passed in parameter.
1223 my ( $dbh, $bibid, $itemnumber ) = @_;
1224 my $record = MARC::Record->new();
1226 # search MARC tagorder
1229 "select tagorder from marc_subfield_table,marc_subfield_structure where marc_subfield_table.tag=marc_subfield_structure.tagfield and marc_subfield_table.subfieldcode=marc_subfield_structure.tagsubfield and bibid=? and kohafield='items.itemnumber' and subfieldvalue=?"
1231 $sth2->execute( $bibid, $itemnumber );
1232 my ($tagorder) = $sth2->fetchrow_array();
1234 #---- TODO : the leader is missing
1237 "select bibid,subfieldid,tag,tagorder,tag_indicator,subfieldcode,subfieldorder,subfieldvalue,valuebloblink
1238 from marc_subfield_table
1239 where bibid=? and tagorder=? order by subfieldcode,subfieldorder
1244 "select subfieldvalue from marc_blob_subfield where blobidlink=?");
1245 $sth->execute( $bibid, $tagorder );
1246 while ( my $row = $sth->fetchrow_hashref ) {
1247 if ( $row->{'valuebloblink'} ) { #---- search blob if there is one
1248 $sth2->execute( $row->{'valuebloblink'} );
1249 my $row2 = $sth2->fetchrow_hashref;
1251 $row->{'subfieldvalue'} = $row2->{'subfieldvalue'};
1253 if ( $record->field( $row->{'tag'} ) ) {
1256 #--- this test must stay as this, because of strange behaviour of mySQL/Perl DBI with char var containing a number...
1257 #--- sometimes, eliminates 0 at beginning, sometimes no ;-\\\
1258 if ( length( $row->{'tag'} ) < 3 ) {
1259 $row->{'tag'} = "0" . $row->{'tag'};
1261 $field = $record->field( $row->{'tag'} );
1264 $field->add_subfields( $row->{'subfieldcode'},
1265 $row->{'subfieldvalue'} );
1266 $record->delete_field($field);
1267 $record->add_fields($field);
1271 if ( length( $row->{'tag'} ) < 3 ) {
1272 $row->{'tag'} = "0" . $row->{'tag'};
1275 MARC::Field->new( $row->{'tag'}, " ", " ",
1276 $row->{'subfieldcode'} => $row->{'subfieldvalue'} );
1277 $record->add_fields($temp);
1288 # Revision 1.132 2006/04/06 12:37:05 hdl
1289 # Bugfixing : aqbookfund needed a field.
1291 # Revision 1.131 2006/03/03 17:02:22 tipaul
1292 # commit for holidays and news management.
1293 # (some forgotten files)
1295 # Revision 1.130 2006/03/03 16:35:21 tipaul
1296 # commit for holidays and news management.
1298 # Contrib from Tümer Garip (from Turkey) :
1300 # in /tools/ the holiday.pl script let you define holidays (days where the library is closed), branch by branch. You can define 3 types of holidays :
1301 # - single day : only this day is closed
1302 # - repet weekly (like "sunday") : the day is holiday every week
1303 # - repet yearly (like "July, 4") : this day is closed every year.
1305 # You can also put exception :
1306 # - sunday is holiday, but "2006 March, 5th" the library will be open
1308 # The holidays are used for return date calculation : the return date is set to the next date where the library is open. A systempreference (useDaysMode) set ON (Calendar) or OFF (Normal) the calendar calculation.
1310 # Revision 1.129 2006/02/27 18:19:33 hdl
1311 # New table used in overduerules.pl tools page.
1313 # Revision 1.128 2006/01/25 15:16:06 tipaul
1315 # * removing useless tables
1316 # * adding useful indexes
1317 # * altering some columns definitions
1318 # * The goal being to have updater working fine for foreign keys.
1320 # For me it's done, let me know if it works for you. You can see an updated schema of the DB (with constraints) on the wiki
1322 # Revision 1.127 2006/01/24 17:57:17 tipaul
1323 # DB improvements : adding foreign keys on some tables. partial stuff done.
1325 # Revision 1.126 2006/01/06 16:39:42 tipaul
1326 # synch'ing head and rel_2_2 (from 2.2.5, including npl templates)
1327 # Seems not to break too many things, but i'm probably wrong here.
1328 # at least, new features/bugfixes from 2.2.5 are here (tested on some features on my head local copy)
1330 # - removing useless directories (koha-html and koha-plucene)
1332 # Revision 1.125 2006/01/04 15:54:55 tipaul
1333 # utf8 is a : go for beta test in HEAD.
1334 # some explanations :
1335 # - updater/updatedatabase => will transform all tables in innoDB (not related to utf8, just to warn you) AND collate them in utf8 / utf8_general_ci. The SQL command is : ALTER TABLE tablename DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci.
1336 # - *-top.inc will show the pages in utf8
1337 # - THE HARD THING : for me, mysql-client and mysql-server were set up to communicate in iso8859-1, whatever the mysql collation ! Thus, pages were improperly shown, as datas were transmitted in iso8859-1 format ! After a full day of investigation, someone on usenet pointed "set NAMES 'utf8'" to explain that I wanted utf8. I could put this in my.cnf, but if I do that, ALL databases will "speak" in utf8, that's not what we want. Thus, I added a line in Context.pm : everytime a DB handle is opened, the communication is set to utf8.
1338 # - using marcxml field and no more the iso2709 raw marc biblioitems.marc field.
1340 # Revision 1.124 2005/10/27 12:09:05 tipaul
1341 # new features for serial module :
1342 # - the last 5 issues are now shown, and their status can be changed (but not reverted to "waited", as there can be only one "waited")
1343 # - the library can create a "distribution list". this paper contains a list of borrowers (selected from the borrower list, or manually entered), and print it for a given issue. once printed, the sheet can be put on the issue and distributed to every reader on the list (one by one).
1345 # Revision 1.123 2005/10/26 09:13:37 tipaul
1346 # big commit, still breaking things...
1348 # * synch with rel_2_2. Probably the last non manual synch, as rel_2_2 should not be modified deeply.
1349 # * code cleaning (cleaning warnings from perl -w) continued
1351 # Revision 1.122 2005/09/02 14:18:38 tipaul
1352 # new feature : image for itemtypes.
1354 # * run updater/updatedatabase to create imageurl field in itemtypes.
1355 # * go to Koha >> parameters >> itemtypes >> modify (or add) an itemtype. You will see around 20 nice images to choose between (thanks to owen). If you prefer your own image, you also can type a complete url (http://www.myserver.lib/path/to/my/image.gif)
1356 # * go to OPAC, and search something. In the result list, you now have the picture instead of the text itemtype.
1358 # Revision 1.121 2005/08/24 08:49:03 hdl
1359 # Adding a note field in serial table.
1360 # This will allow librarian to mention a note on a peculiar waiting serial number.
1362 # Revision 1.120 2005/08/09 14:10:32 tipaul
1363 # 1st commit to go to zebra.
1364 # don't update your cvs if you want to have a working head...
1366 # this commit contains :
1367 # * updater/updatedatabase : get rid with marc_* tables, but DON'T remove them. As a lot of things uses them, it would not be a good idea for instance to drop them. If you really want to play, you can rename them to test head without them but being still able to reintroduce them...
1368 # * Biblio.pm : modify MARCgetbiblio to find the raw marc record in biblioitems.marc field, not from marc_subfield_table, modify MARCfindframeworkcode to find frameworkcode in biblio.frameworkcode, modify some other subs to use biblio.biblionumber & get rid of bibid.
1369 # * other files : get rid of bibid and use biblionumber instead.
1372 # * does not do anything on zebra yet.
1373 # * if you rename marc_subfield_table, you can't search anymore.
1374 # * you can view a biblio & bibliodetails, go to MARC editor, but NOT save any modif.
1375 # * don't try to add a biblio, it would add data poorly... (don't try to delete either, it may work, but that would be a surprise ;-) )
1377 # IMPORTANT NOTE : you need MARC::XML package (http://search.cpan.org/~esummers/MARC-XML-0.7/lib/MARC/File/XML.pm), that requires a recent version of MARC::Record
1378 # Updatedatabase stores the iso2709 data in biblioitems.marc field & an xml version in biblioitems.marcxml Not sure we will keep it when releasing the stable version, but I think it's a good idea to have something readable in sql, at least for development stage.
1380 # Revision 1.119 2005/08/04 16:07:58 tipaul
1381 # Synch really broke this script...
1383 # Revision 1.118 2005/08/04 16:02:55 tipaul
1384 # oops... error in synch between 2.2 and head
1386 # Revision 1.117 2005/08/04 14:24:39 tipaul
1387 # synch'ing 2.2 and head
1389 # Revision 1.116 2005/08/04 08:55:54 tipaul
1390 # Letters / alert system, continuing...
1392 # * adding a package Letters.pm, that manages Letters & alerts.
1393 # * adding feature : it's now possible to define a "letter" for any subscription created. If a letter is defined, users in OPAC can put an alert on the subscription. When an issue is marked "arrived", all users in the alert will recieve a mail (as defined in the "letter"). This last part (= send the mail) is not yet developped. (Should be done this week)
1394 # * adding feature : it's now possible to "put to an alert" in OPAC, for any serial subscription. The alert is stored in a new table, called alert. An alert can be put only if the librarian has activated them in subscription (and they activate it just by choosing a "letter" to sent to borrowers on new issues)
1395 # * adding feature : librarian can see in borrower detail which alerts they have put, and a user can see in opac-detail which alert they have put too.
1397 # Note that the system should be generic enough to manage any type of alert.
1398 # I plan to extend it soon to virtual shelves : a borrower will be able to put an alert on a virtual shelf, to be warned when something is changed in the virtual shelf (mail being sent once a day by cron, or manually by the shelf owner. Anyway, a mail won't be sent on every change, users would be spammed by Koha ;-) )
1400 # Revision 1.115 2005/08/02 16:15:34 tipaul
1401 # adding 2 fields to letter system :
1402 # * module (acquisition, catalogue...) : it will be usefull to show the librarian only letters he may be interested by.
1403 # * title, that will be used as mail subject.
1405 # Revision 1.114 2005/07/28 15:10:13 tipaul
1406 # Introducing new "Letters" system : Letters will be used everytime you want to sent something to someone (through mail or paper). For example, sending a mail for overdues use letter that you can put as parameters. Sending a mail to a borrower when a suggestion is validated uses a letter too.
1407 # the letter table contains 3 fields :
1408 # * code => the code of the letter
1409 # * name => the complete name of the letter
1410 # * content => the complete text. It's a TEXT field type, so has no limits.
1412 # My next goal now is to work on point 2-I "serial issue alert"
1413 # With this feature, in serials, a user can subscribe the "issue alert". For every issue arrived/missing, a mail is sent to all subscribers of this list. The mail warns the user that the issue is arrive or missing. Will be in head.
1414 # (see mail on koha-devel, 2005/04/07)
1416 # The "serial issue alert" will be the 1st to use this letter system that probably needs some tweaking ;-)
1418 # Once it will be stabilised default letters (in any languages) could be added during installer to help the library begin with this new feature.
1420 # Revision 1.113 2005/07/28 08:38:41 tipaul
1421 # For instance, the return date does not rely on the borrower expiration date. A systempref will be added in Koha, to modify return date calculation schema :
1422 # * ReturnBeforeExpiry = yes => return date can't be after expiry date
1423 # * ReturnBeforeExpiry = no => return date can be after expiry date
1425 # Revision 1.112 2005/07/26 08:19:47 hdl
1426 # Adding IndependantBranches System preference variable in order to manage Branch independancy.
1428 # Revision 1.111 2005/07/25 15:35:38 tipaul
1429 # we have decided that moving to Koha 3.0 requires being already in Koha 2.2.x
1430 # So, the updatedatabase script can highly be cleaned (90% removed).
1431 # Let's play with the new Koha DB structure now ;-)