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.
15 use lib "/usr/koha200pre2/modules";
24 # FIXME - The user might be installing a new database, so can't rely
25 # on /etc/koha.conf anyway.
32 %existingtables, # tables already in database
36 $type, $null, $key, $default, $extra,
37 $prefitem, # preference item in systempreferences table
44 my $dbh = C4::Context->dbh;
45 print "connected to your DB. Checking & modifying it\n" unless $silent;
50 # Tables to add if they don't exist
52 shelfcontents => "( shelfnumber int not null,
53 itemnumber int not null,
55 bookshelf => "( shelfnumber int auto_increment primary key,
56 shelfname char(255))",
57 z3950queue => "( id int auto_increment primary key,
66 identifier char(30))",
67 z3950results => "( id int auto_increment primary key,
77 branchrelations => "( branchcode varchar(4),
78 categorycode varchar(4))",
79 websites => "( websitenumber int(11) NOT NULL auto_increment,
80 biblionumber int(11) NOT NULL default '0',
84 PRIMARY KEY (websitenumber) )",
85 marcrecorddone => "( isbn char(40),
88 controlnumber char(40))",
89 uploadedmarc => "( id int(11) NOT NULL auto_increment PRIMARY KEY,
91 hidden smallint(6) default NULL,
92 name varchar(255) default NULL)",
93 ethnicity => "( code varchar(10) NOT NULL default '',
94 name varchar(255) default NULL,
95 PRIMARY KEY (code) )",
96 sessions => "( sessionID varchar(255) NOT NULL default '',
97 userid varchar(255) default NULL,
98 ip varchar(16) default NULL,
100 PRIMARY KEY (sessionID) )",
101 sessionqueries => "( sessionID varchar(255) NOT NULL default '',
102 userid char(100) NOT NULL default '',
103 ip char(18) NOT NULL default '',
104 url text NOT NULL default '' )",
105 bibliothesaurus => "( id bigint(20) NOT NULL auto_increment,
106 freelib char(255) NOT NULL default '',
107 stdlib char(255) NOT NULL default '',
108 category char(10) NOT NULL default '',
109 level tinyint(4) NOT NULL default '1',
110 hierarchy char(80) NOT NULL default '',
111 father char(80) NOT NULL default '',
113 KEY freelib (freelib),
115 KEY category (category),
116 KEY hierarchy (hierarchy)
119 bibid bigint(20) unsigned NOT NULL auto_increment,
120 biblionumber int(11) NOT NULL default '0',
121 datecreated date NOT NULL default '0000-00-00',
122 datemodified date default NULL,
123 origincode char(20) default NULL,
125 KEY origincode (origincode),
126 KEY biblionumber (biblionumber)
128 marc_blob_subfield => "(
129 blobidlink bigint(20) NOT NULL auto_increment,
130 subfieldvalue longtext NOT NULL,
131 PRIMARY KEY (blobidlink)
133 marc_subfield_structure => "(
134 tagfield char(3) NOT NULL default '',
135 tagsubfield char(1) NOT NULL default '',
136 liblibrarian char(255) NOT NULL default '',
137 libopac char(255) NOT NULL default '',
138 repeatable tinyint(4) NOT NULL default '0',
139 mandatory tinyint(4) NOT NULL default '0',
140 kohafield char(40) default NULL,
141 tab tinyint(1) default NULL,
142 authorised_value char(10) default NULL,
143 thesaurus_category char(10) default NULL,
144 value_builder char(80) default NULL,
145 PRIMARY KEY (tagfield,tagsubfield),
146 KEY kohafield (kohafield),
149 marc_subfield_table => "(
150 subfieldid bigint(20) unsigned NOT NULL auto_increment,
151 bibid bigint(20) unsigned NOT NULL default '0',
152 tag char(3) NOT NULL default '',
153 tagorder tinyint(4) NOT NULL default '1',
154 tag_indicator char(2) NOT NULL default '',
155 subfieldcode char(1) NOT NULL default '',
156 subfieldorder tinyint(4) NOT NULL default '1',
157 subfieldvalue varchar(255) default NULL,
158 valuebloblink bigint(20) default NULL,
159 PRIMARY KEY (subfieldid),
162 KEY tag_indicator (tag_indicator),
163 KEY subfieldorder (subfieldorder),
164 KEY subfieldcode (subfieldcode),
165 KEY subfieldvalue (subfieldvalue),
166 KEY tagorder (tagorder)
168 marc_tag_structure => "(
169 tagfield char(3) NOT NULL default '',
170 liblibrarian char(255) NOT NULL default '',
171 libopac char(255) NOT NULL default '',
172 repeatable tinyint(4) NOT NULL default '0',
173 mandatory tinyint(4) NOT NULL default '0',
174 authorised_value char(10) default NULL,
175 PRIMARY KEY (tagfield)
178 bibid bigint(20) NOT NULL default '0',
179 tag char(3) NOT NULL default '',
180 tagorder tinyint(4) NOT NULL default '1',
181 subfieldid char(1) NOT NULL default '',
182 subfieldorder tinyint(4) NOT NULL default '1',
183 word varchar(255) NOT NULL default '',
184 sndx_word varchar(255) NOT NULL default '',
187 KEY tagorder (tagorder),
188 KEY subfieldid (subfieldid),
189 KEY subfieldorder (subfieldorder),
191 KEY sndx_word (sndx_word)
193 marc_breeding => "( id bigint(20) NOT NULL auto_increment,
194 file varchar(80) NOT NULL default '',
195 isbn varchar(10) NOT NULL default '',
196 title varchar(128) default NULL,
197 author varchar(80) default NULL,
199 encoding varchar(40) default NULL,
204 authorised_values => "(id int(11) NOT NULL auto_increment,
205 category char(10) NOT NULL default '',
206 authorised_value char(80) NOT NULL default '',
211 userflags => "( bit int(11) NOT NULL default '0',
212 flag char(30), flagdesc char(255),
216 authtypecode char(10) not NULL,
217 authtypetext char(255) not NULL,
218 auth_tag_to_report char(3) not NULL,
219 summary text not NULL,
220 PRIMARY KEY (authtypecode)
222 biblio_framework => "(
223 frameworkcode char(4) not NULL,
224 frameworktext char(255) not NULL,
225 PRIMARY KEY (frameworkcode)
227 auth_subfield_structure => "(
228 authtypecode char(10) NOT NULL default '',
229 tagfield char(3) NOT NULL default '',
230 tagsubfield char(1) NOT NULL default '',
231 liblibrarian char(255) NOT NULL default '',
232 libopac char(255) NOT NULL default '',
233 repeatable tinyint(4) NOT NULL default '0',
234 mandatory tinyint(4) NOT NULL default '0',
235 tab tinyint(1) default NULL,
236 authorised_value char(10) default NULL,
237 value_builder char(80) default NULL,
238 seealso char(255) default NULL,
239 PRIMARY KEY (authtypecode,tagfield,tagsubfield),
240 KEY tab (authtypecode,tab)
242 auth_tag_structure => "(
243 authtypecode char(10) NOT NULL default '',
244 tagfield char(3) NOT NULL default '',
245 liblibrarian char(255) NOT NULL default '',
246 libopac char(255) NOT NULL default '',
247 repeatable tinyint(4) NOT NULL default '0',
248 mandatory tinyint(4) NOT NULL default '0',
249 authorised_value char(10) default NULL,
250 PRIMARY KEY (authtypecode,tagfield)
253 authid bigint(20) unsigned NOT NULL auto_increment,
254 authtypecode char(10) NOT NULL default '',
255 datecreated date NOT NULL default '0000-00-00',
256 datemodified date default NULL,
257 origincode char(20) default NULL,
258 PRIMARY KEY (authid),
259 KEY origincode (origincode)
261 auth_subfield_table => "(
262 subfieldid bigint(20) unsigned NOT NULL auto_increment,
263 authid bigint(20) unsigned NOT NULL default '0',
264 tag char(3) NOT NULL default '',
265 tagorder tinyint(4) NOT NULL default '1',
266 tag_indicator char(2) NOT NULL default '',
267 subfieldcode char(1) NOT NULL default '',
268 subfieldorder tinyint(4) NOT NULL default '1',
269 subfieldvalue varchar(255) default NULL,
270 PRIMARY KEY (subfieldid),
273 KEY subfieldcode (subfieldcode),
274 KEY subfieldvalue (subfieldvalue)
277 authid bigint(20) NOT NULL default '0',
278 tagsubfield char(4) NOT NULL default '',
279 tagorder tinyint(4) NOT NULL default '1',
280 subfieldorder tinyint(4) NOT NULL default '1',
281 word varchar(255) NOT NULL default '',
282 sndx_word varchar(255) NOT NULL default '',
284 KEY marc_search (tagsubfield,word),
286 KEY sndx_word (sndx_word)
289 suggestionid int(8) NOT NULL auto_increment,
290 suggestedby int(11) NOT NULL default '0',
291 managedby int(11) default NULL ,
292 STATUS varchar(10) NOT NULL default '',
294 author varchar(80) default NULL ,
295 title varchar(80) default NULL ,
296 copyrightdate smallint(6) default NULL ,
297 publishercode varchar(255) default NULL ,
298 date timestamp(8) NOT NULL ,
299 volumedesc varchar(255) default NULL ,
300 publicationyear smallint(6) default '0',
301 place varchar(255) default NULL ,
302 isbn varchar(10) default NULL ,
303 mailoverseeing smallint(1) default '0',
304 biblionumber int(11) default NULL ,
305 PRIMARY KEY (suggestionid) ,
306 KEY suggestedby(suggestedby) ,
307 KEY managedby(managedby)
309 aqbasket => "(basketno int(11) NOT NULL auto_increment,
312 booksellerid varchar(10),
313 authorisedby varchar(10),
314 booksellerinvoicenumber text,
315 PRIMARY KEY (basketno)
317 serial => "(serialid int(11) NOT NULL auto_increment,
318 biblionumber varchar(100) NOT NULL default '',
319 subscriptionid varchar(100) NOT NULL default '',
320 serialseq varchar(100) NOT NULL default '',
321 status tinyint(4) NOT NULL default '0',
322 planneddate date NOT NULL default '0000-00-00',
323 PRIMARY KEY (serialid)
325 subscription => "(biblionumber int(11) NOT NULL default '0',
326 subscriptionid int(11) NOT NULL auto_increment,
327 librarian varchar(100) default '',
328 startdate date default '0000-00-00',
329 aqbooksellerid int(11) default '0',
330 cost int(11) default '0',
331 aqbudgetid int(11) default '0',
332 weeklength tinyint(4) default '0',
333 monthlength tinyint(4) default '0',
334 numberlength tinyint(4) default '0',
335 periodicity tinyint(4) default '0',
336 dow varchar(100) default '',
337 numberingmethod varchar(100) default '',
339 status varchar(100) NOT NULL default '',
340 add1 int(11) default 0,
341 every1 int(11) default 0,
342 whenmorethan1 int(11) default 0,
345 add2 int(11) default 0,
346 every2 int(11) default 0,
347 whenmorethan2 int(11) default 0,
350 add3 int(11) default 0,
351 every3 int(11) default 0,
352 innerloop1 int(11) default 0,
353 innerloop2 int(11) default 0,
354 innerloop3 int(11) default 0,
355 whenmorethan3 int(11) default 0,
358 PRIMARY KEY (subscriptionid)
360 subscriptionhistory => "(biblionumber int(11) NOT NULL default '0',
361 subscriptionid int(11) NOT NULL default '0',
362 histstartdate date NOT NULL default '0000-00-00',
363 enddate date default '0000-00-00',
364 missinglist longtext NOT NULL,
365 recievedlist longtext NOT NULL,
366 opacnote varchar(150) NOT NULL default '',
367 librariannote varchar(150) NOT NULL default '',
368 PRIMARY KEY (subscriptionid),
369 KEY biblionumber (biblionumber)
371 categorytable => "(categorycode char(5) NOT NULL default '',
372 description text default '',
373 itemtypecodes text default '',
374 PRIMARY KEY (categorycode)
376 subcategorytable => "(subcategorycode char(5) NOT NULL default '',
377 description text default '',
378 itemtypecodes text default '',
379 PRIMARY KEY (subcategorycode)
381 mediatypetable => "(mediatypecode char(5) NOT NULL default '',
382 description text default '',
383 itemtypecodes text default '',
384 PRIMARY KEY (mediatypecode)
388 my %requirefields = (
389 biblio => { 'abstract' => 'text' },
390 deletedbiblio => { 'abstract' => 'text', 'marc' => 'blob' },
391 deleteditems => { 'marc' => 'blob', 'paidfor' => 'text', 'location' => 'varchar(80)'},
393 'lccn' => 'char(25)',
394 'url' => 'varchar(255)',
397 deletedbiblioitems => {
398 'lccn' => 'char(25)',
399 'url' => 'varchar(255)',
402 branchtransfers => { 'datearrived' => 'datetime' },
403 statistics => { 'borrowernumber' => 'int(11)' },
405 'invoicedisc' => 'float(6,4)',
406 'nocalc' => 'int(11)'
409 'userid' => 'char(30)',
410 'password' => 'char(30)',
411 'flags' => 'int(11)',
412 'textmessaging' => 'varchar(30)',
413 'zipcode' => 'varchar(25)',
414 'homezipcode' => 'varchar(25)',
415 'sort1' => 'char(80)',
416 'sort2' => 'char(80)',
418 aqorders => { 'budgetdate' => 'date',
419 'sort1' => 'char(80)',
420 'sort2' => 'char(80)', },
421 aqbookfund =>{'branchcode'=> 'varchar(4) NULL'},
422 aqbudget => {'aqbudgetid' => 'tinyint(4) auto_increment primary key', 'branchcode'=> 'varchar(4) NULL'},
423 items => {'paidfor' => 'text', 'location' => 'char(80)'},
425 #added so that reference items are not available for reserves...
426 itemtypes => { 'notforloan' => 'smallint(6)' },
427 systempreferences => { 'explanation' => 'char(80)',
428 'type' => 'char(20)',
429 'options' => 'text' },
430 z3950servers => { 'syntax' => 'char(80)' },
431 marc_tag_structure =>{
432 'frameworkcode' => 'char(4) not NULL default \'\''},
433 marc_subfield_structure =>{'seealso' => 'char(255)',
434 'frameworkcode' => 'char(4) not NULL default \'\'',
435 'hidden' => 'tinyint(1)',
436 'isurl' => 'tinyint(1)',
437 'link' => 'char(80)',
439 bookshelf => {'owner' => 'char(80)',
440 'category' => 'char(1)',
442 marc_biblio => { 'frameworkcode' => 'char(4) not NULL default \'\'' },
445 my %dropable_table = (
446 classification => 'classification',
447 multipart => 'multipart',
448 multivolume => 'multivolume',
449 newitems => 'newitems',
450 procedures => 'procedures',
451 publisher => 'publisher',
452 searchstats => 'searchstats',
453 serialissues => 'serialissues',
456 my %uselessfields = (
457 aqorders => "requisitionedby,authorisedby,booksellerid,
458 deliverydays,followupdays,
459 numberfollowupsallowed,numberfollowupssent,
460 dateprinted,sourced,quantityreceiveddamaged,
461 subscriptionfrom,subscriptionto
464 # the other hash contains other actions that can't be done elsewhere. they are done
465 # either BEFORE of AFTER everything else, depending on "when" entry (default => AFTER)
467 # The tabledata hash contains data that should be in the tables.
468 # The uniquefieldrequired hash entry is used to determine which (if any) fields
469 # must not exist in the table for this row to be inserted. If the
470 # uniquefieldrequired entry is already in the table, the existing data is not
471 # modified, unless the forceupdate hash entry is also set. Fields in the
472 # anonymous "forceupdate" hash will be forced to be updated to the default
473 # values given in the %tabledata hash.
478 uniquefieldrequired => 'bit',
480 flag => 'superlibrarian',
481 flagdesc => 'Access to all librarian functions',
485 uniquefieldrequired => 'bit',
488 flagdesc => 'Circulate books',
492 uniquefieldrequired => 'bit',
495 flagdesc => 'View Catalogue (Librarian Interface)',
499 uniquefieldrequired => 'bit',
501 flag => 'parameters',
502 flagdesc => 'Set Koha system paramters',
506 uniquefieldrequired => 'bit',
509 flagdesc => 'Add or modify borrowers',
513 uniquefieldrequired => 'bit',
515 flag => 'permissions',
516 flagdesc => 'Set user permissions',
520 uniquefieldrequired => 'bit',
522 flag => 'reserveforothers',
523 flagdesc => 'Reserve books for patrons',
527 uniquefieldrequired => 'bit',
530 flagdesc => 'Borrow books',
534 uniquefieldrequired => 'bit',
536 flag => 'reserveforself',
537 flagdesc => 'Reserve books for self',
541 uniquefieldrequired => 'bit',
543 flag => 'editcatalogue',
544 flagdesc => 'Edit Catalogue (Modify bibliographic/holdings data)',
548 uniquefieldrequired => 'bit',
550 flag => 'updatecharges',
551 flagdesc => 'Update borrower charges',
555 uniquefieldrequired => 'bit',
557 flag => 'acquisition',
558 flagdesc => 'Acquisition and/or suggestion management',
562 uniquefieldrequired => 'bit',
564 flag => 'management',
565 flagdesc => 'Set library management parameters',
569 uniquefieldrequired => 'bit',
572 flagdesc => 'Use tools (export, import, barcodes)',
576 systempreferences => [
578 uniquefieldrequired => 'variable',
579 forceupdate => { 'explanation' => 1,
581 variable => 'LibraryName',
582 value => '<i><b>Koha<br/>Free Software ILS<br/><br/></b>Koha : a gift, a contribution<br/> in Maori</i>',
583 explanation => 'Library name as shown on main opac page',
588 uniquefieldrequired => 'variable',
589 forceupdate => { 'explanation' => 1,
591 variable => 'autoMemberNum',
593 explanation => 'Member number is auto-calculated',
598 uniquefieldrequired => 'variable',
599 forceupdate => { 'explanation' => 1,
602 variable => 'acquisitions',
605 'Normal, budget-based acquisitions, or Simple bibliographic-data acquisitions',
607 options => 'simple|normal'
610 uniquefieldrequired => 'variable',
611 forceupdate => { 'explanation' => 1,
614 variable => 'dateformat',
617 'date format (us mm/dd/yyyy, metric dd/mm/yyy, ISO yyyy/mm/dd)',
619 options => 'metric|us|iso'
622 uniquefieldrequired => 'variable',
623 variable => 'template',
624 forceupdate => { 'explanation' => 1,
627 explanation => 'Preference order for intranet interface templates',
631 uniquefieldrequired => 'variable',
632 variable => 'autoBarcode',
633 forceupdate => { 'explanation' => 1,
636 explanation => 'Barcode is auto-calculated',
640 uniquefieldrequired => 'variable',
641 variable => 'insecure',
642 forceupdate => { 'explanation' => 1,
646 'If YES, no auth at all is needed. Be careful if you set this to yes!',
650 uniquefieldrequired => 'variable',
651 variable => 'authoritysep',
652 forceupdate => { 'explanation' => 1,
657 'the separator used in authority/thesaurus. Usually --',
662 uniquefieldrequired => 'variable',
663 variable => 'opaclanguages',
664 forceupdate => { 'explanation' => 1,
667 explanation => 'Set the preferred order for translations. The top language will be tried first.',
671 uniquefieldrequired => 'variable',
672 variable => 'opacthemes',
673 forceupdate => { 'explanation' => 1,
676 explanation => 'Set the preferred order for themes. The top theme will be tried first.',
680 uniquefieldrequired => 'variable',
681 variable => 'timeout',
682 forceupdate => { 'explanation' => 1,
685 explanation => 'Inactivity timeout for cookies authentication (in seconds)',
689 uniquefieldrequired => 'variable',
691 forceupdate => { 'explanation' => 1,
694 explanation => 'Turn on MARC support',
698 uniquefieldrequired => 'variable',
699 variable => 'marcflavour',
700 forceupdate => { 'explanation' => 1,
705 'your MARC flavor (MARC21 or UNIMARC) used for character encoding',
707 options => 'MARC21|UNIMARC'
710 uniquefieldrequired => 'variable',
711 variable => 'checkdigit',
713 forceupdate => { 'explanation' => 1,
716 explanation => 'Validity checks on membership number: none or "Katipo" style checks',
718 options => 'none|katipo'
721 uniquefieldrequired => 'variable',
722 variable => 'maxoutstanding',
723 forceupdate => { 'explanation' => 1,
727 'maximum amount withstanding to be able make reserves ',
731 uniquefieldrequired => 'variable',
732 variable => 'maxreserves',
733 forceupdate => { 'explanation' => 1,
737 'maximum number of reserves a member can make',
742 uniquefieldrequired => 'variable',
743 variable => 'noissuescharge',
744 forceupdate => { 'explanation' => 1,
748 'maximum amount withstanding to be able to check out an item',
753 uniquefieldrequired => 'variable',
754 variable => 'KohaAdminEmailAddress',
755 forceupdate => { 'explanation' => 1,
757 value => 'your.mail@here',
758 explanation => 'the email address where borrowers modifs are sent',
762 uniquefieldrequired => 'variable',
764 forceupdate => { 'explanation' => 1,
767 explanation => 'the gist rate. NOT in %, but in numeric form (0.12 for 12%)',
771 uniquefieldrequired => 'variable',
772 variable => 'printcirculationslips',
773 forceupdate => { 'explanation' => 1,
776 explanation => 'if set to 1, print circulation slips. If set to 0, don\'t',
780 uniquefieldrequired => 'variable',
781 variable => 'suggestion',
782 forceupdate => { 'explanation' => 1,
785 explanation => 'if set to 1, suggestions are activated in OPAC',
789 uniquefieldrequired => 'variable',
791 forceupdate => { 'explanation' => 1,
793 value => 'Fill with appropriate value...',
794 explanation => 'ISBD',
798 uniquefieldrequired => 'variable',
799 variable => 'virtualshelves',
800 forceupdate => { 'explanation' => 1,
803 explanation => 'Set virtual shelves management ON or OFF',
807 uniquefieldrequired => 'variable',
808 variable => 'itemcallnumber',
809 forceupdate => { 'explanation' => 1,
812 explanation => 'The MARC field/subfield that is used to calculate the itemcallnumber (in UNIMARC : 676a for Dewey, 680a for Loc)',
816 uniquefieldrequired => 'variable',
817 variable => 'BiblioDefaultView',
819 forceupdate => { 'explanation' => 1,
822 explanation => 'Define the default view of a biblio. Can be either normal, marc or isbd',
824 options => 'normal|marc|isbd'
827 uniquefieldrequired => 'variable',
828 variable => 'opacstylesheet',
830 forceupdate => { 'explanation' => 1,
832 explanation => 'Enter a complete URL to use an alternate stylesheet in OPAC',
836 uniquefieldrequired => 'variable',
837 variable => 'opacsmallimage',
839 forceupdate => { 'explanation' => 1,
841 explanation => 'Enter a complete URL to an image, will be on top/left instead of the Koha logo',
845 uniquefieldrequired => 'variable',
846 variable => 'opaclargeimage',
848 forceupdate => { 'explanation' => 1,
850 explanation => 'Enter a complete URL to an image, will be on the main page, instead of the Koha logo',
854 uniquefieldrequired => 'variable',
855 variable => 'delimiter',
857 forceupdate => { 'explanation' => 1,
859 explanation => 'separator for reports exported to spreadsheet',
863 uniquefieldrequired => 'variable',
865 value => 'OPENOFFICE.ORG',
866 forceupdate => { 'explanation' => 1,
869 explanation => 'Define the default application for report exportations into files',
871 options => 'EXCEL|OPENOFFICE.ORG'
874 uniquefieldrequired => 'variable',
875 variable => 'Delimiter',
877 forceupdate => { 'explanation' => 1,
880 explanation => 'Define the default separator character for report exportations into files',
882 options => ';|tabulation|,|/|\|#'
885 uniquefieldrequired => 'variable',
886 variable => 'SubscriptionHistory',
888 forceupdate => { 'explanation' => 1,
891 explanation => 'Define the information level for serials history in OPAC',
893 options => 'simplified|full'
896 uniquefieldrequired => 'variable',
897 variable => 'hidelostitems',
899 forceupdate => { 'explanation' => 1,
901 explanation => 'show or hide "lost" items in OPAC.',
908 my %fielddefinitions = (
911 field => 'printername',
920 field => 'bookfundid',
927 field => 'branchcode',
928 type => 'varchar(4)',
937 field => 'aqbudgetid',
938 type => 'tinyint(4)',
942 extra => 'auto_increment'
945 field => 'branchcode',
946 type => 'varchar(4)',
960 extra => 'auto_increment'
965 field => 'z3950random',
966 type => 'varchar(40)',
974 type => 'varchar(40)',
988 # Get version of MySQL database engine.
989 my $mysqlversion = `mysqld --version`;
990 $mysqlversion =~ /Ver (\S*) /;
992 if ( $mysqlversion ge '3.23' ) {
993 print "Could convert to MyISAM database tables...\n" unless $silent;
996 #---------------------------------
999 # Collect all tables into a list
1000 $sth = $dbh->prepare("show tables");
1002 while ( my ($table) = $sth->fetchrow ) {
1003 $existingtables{$table} = 1;
1007 # Now add any missing tables
1008 foreach $table ( keys %requiretables ) {
1009 unless ( $existingtables{$table} ) {
1010 print "Adding $table table...\n" unless $silent;
1011 my $sth = $dbh->prepare("create table $table $requiretables{$table}");
1014 print "Error : $sth->errstr \n";
1020 # now drop useless tables
1021 foreach $table ( keys %dropable_table ) {
1022 if ( $existingtables{$table} ) {
1023 print "Dropping unused table $table\n" if $debug and not $silent;
1024 $dbh->do("drop table $table");
1026 print "Error : $dbh->errstr \n";
1030 unless ( $existingtables{'z3950servers'} ) {
1031 #MJR: added syntax entries to close bug 624
1032 print "Adding z3950servers table...\n" unless $silent;
1033 my $sti = $dbh->prepare( "create table z3950servers (
1046 $sti = $dbh->prepare( "insert into z3950servers
1047 values ('z3950.loc.gov',
1051 'Library of Congress',
1056 unless ( $existingtables{'issuingrules'} ) {
1057 $dbh->do("alter table categoryitem rename issuingrules");
1058 $dbh->do("ALTER TABLE issuingrules ADD maxissueqty int(4) default NULL");
1059 $dbh->do("ALTER TABLE issuingrules ADD issuelength int(4) default NULL");
1060 $dbh->do("ALTER TABLE issuingrules ADD branchcode varchar(4) NOT NULL default ''");
1061 print "renaming categoryitem\n" unless $silent;
1065 #---------------------------------
1068 foreach $table ( keys %requirefields ) {
1069 print "Check table $table\n" if $debug and not $silent;
1070 $sth = $dbh->prepare("show columns from $table");
1073 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1075 $types{$column} = $type;
1077 foreach $column ( keys %{ $requirefields{$table} } ) {
1078 print " Check column $column [$types{$column}]\n" if $debug and not $silent;
1079 if ( !$types{$column} ) {
1081 # column doesn't exist
1082 print "Adding $column field to $table table...\n" unless $silent;
1083 $query = "alter table $table
1084 add column $column " . $requirefields{$table}->{$column};
1085 print "Execute: $query\n" if $debug;
1086 my $sti = $dbh->prepare($query);
1089 print "**Error : $sti->errstr \n";
1096 foreach $table ( keys %fielddefinitions ) {
1097 print "Check table $table\n" if $debug;
1098 $sth = $dbh->prepare("show columns from $table");
1101 while ( ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1103 $definitions->{$column}->{type} = $type;
1104 $definitions->{$column}->{null} = $null;
1105 $definitions->{$column}->{key} = $key;
1106 $definitions->{$column}->{default} = $default;
1107 $definitions->{$column}->{extra} = $extra;
1109 my $fieldrow = $fielddefinitions{$table};
1110 foreach my $row (@$fieldrow) {
1111 my $field = $row->{field};
1112 my $type = $row->{type};
1113 my $null = $row->{null};
1114 my $key = $row->{key};
1115 my $default = $row->{default};
1116 $default="''" unless $default;
1117 my $extra = $row->{extra};
1118 my $def = $definitions->{$field};
1119 unless ( $type eq $def->{type}
1120 && $null eq $def->{null}
1121 && $key eq $def->{key}
1122 && $default eq $def->{default}
1123 && $extra eq $def->{extra} )
1126 if ( $null eq '' ) {
1129 if ( $key eq 'PRI' ) {
1130 $key = 'PRIMARY KEY';
1132 unless ( $extra eq 'auto_increment' ) {
1135 # if it's a new column use "add", if it's an old one, use "change".
1137 if ($definitions->{$field}->{type}) {
1138 $action="change $field"
1142 # if it's a primary key, drop the previous pk, before altering the table
1144 if ($key ne 'PRIMARY KEY') {
1145 $sth =$dbh->prepare("alter table $table $action $field $type $null $key $extra default ?");
1147 $sth =$dbh->prepare("alter table $table drop primary key, $action $field $type $null $key $extra default ?");
1149 $sth->execute($default);
1150 print " Alter $field in $table\n" unless $silent;
1155 # Get list of columns from borrowers table
1158 $sth = $dbh->prepare("show columns from borrowers");
1160 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1162 $itemtypes{$column} = $type;
1163 $nullenabled{$column} = $null;
1166 unless ( $itemtypes{'cardnumber'} eq 'varchar(20)' ) {
1167 $itemtypes{'cardnumber'} =~ /varchar\((\d+)\)/;
1169 if ( $oldlength < 16 ) {
1170 print "Setting maximum cardnumber length to 16 (was $oldlength) and marking unique.\n" unless $silent;
1173 "alter table borrowers change cardnumber cardnumber varchar(16)");
1178 "alter table borrowers drop index cardnumber");
1183 "alter table borrowers add unique(cardnumber)");
1189 # Get list of columns from items table
1190 $sth = $dbh->prepare("show columns from items");
1192 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1194 $itemtypes{$column} = $type;
1195 $nullenabled{$column} = $null;
1198 unless ( $itemtypes{'barcode'} eq 'varchar(20)' ) {
1199 $itemtypes{'barcode'} =~ /varchar\((\d+)\)/;
1201 if ( $oldlength < 20 ) {
1202 print "Setting maximum barcode length to 20 (was $oldlength).\n" unless $silent;
1205 "alter table items change barcode barcode varchar(20)");
1210 # dropping unique barcode index & setting barcode to null allowed.
1212 $sth = $dbh->prepare("show index from items");
1214 while ( my ( $table, $non_unique, $key_name, $Seq_in_index, $Column_name, $Collation, $cardinality, $sub_part, $Packed, $comment ) = $sth->fetchrow )
1216 if ($key_name eq 'barcode' && $non_unique eq 0) {
1217 print "dropping BARCODE index to enable empty barcodes\n" unless $silent;
1218 $dbh->do("ALTER TABLE `items` DROP INDEX `barcode`");
1221 $dbh->do("ALTER TABLE `items` CHANGE `barcode` `barcode` VARCHAR( 20 )") unless ($nullenabled{barcode} eq 'YES');
1224 # creating fulltext index in bibliothesaurus if needed
1226 $sth = $dbh->prepare("show index from bibliothesaurus");
1229 while ( my ( $table, $non_unique, $key_name, $Seq_in_index, $Column_name, $Collation, $cardinality, $sub_part, $Packed, $comment ) = $sth->fetchrow )
1231 if ($key_name eq 'category_2') {
1235 print "Creating fulltext index on bibliothesaurus\n" unless $exists or $silent;
1236 $dbh->do('create fulltext index category_2 on bibliothesaurus (category,freelib)') unless $exists;
1239 # creating index in z3950results if needed
1241 $sth = $dbh->prepare("show index from z3950results");
1244 while ( my ( $table, $non_unique, $key_name, $Seq_in_index, $Column_name, $Collation, $cardinality, $sub_part, $Packed, $comment ) = $sth->fetchrow )
1246 if ($key_name eq 'query_server') {
1250 print "Creating index on z3950results\n" unless $exists or $silent;
1251 $dbh->do('create unique index query_server on z3950results (queryid,server)') unless $exists;
1253 # changing z3950daemon field to NULL in marc_breeding
1254 $dbh->do("ALTER TABLE `marc_breeding` CHANGE `z3950random` `z3950random` VARCHAR( 40 )");
1256 # making borrowernumber an auto_increment field
1257 $dbh->do("ALTER TABLE `borrowers` CHANGE `borrowernumber` `borrowernumber` INTEGER auto_increment");
1259 # changing indexes in marc_*_structure to use frameworkcode
1260 $dbh->do('alter table marc_subfield_structure drop index tab');
1261 $dbh->do('create index tab on marc_subfield_structure (frameworkcode,tab)');
1262 $dbh->do('alter table marc_subfield_structure drop index kohafield');
1263 $dbh->do('create index kohafield on marc_subfield_structure (frameworkcode,kohafield)');
1266 # extending the timestamp in branchtransfers...
1267 my %branchtransfers;
1269 $sth = $dbh->prepare("show columns from branchtransfers");
1271 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1273 $branchtransfers{$column} = $type;
1276 unless ( $branchtransfers{'datesent'} eq 'datetime' ) {
1277 print "Setting type of datesent in branchtransfers to datetime.\n" unless $silent;
1280 "alter table branchtransfers change datesent datesent datetime");
1284 unless ( $branchtransfers{'datearrived'} eq 'datetime' ) {
1285 print "Setting type of datearrived in branchtransfers to datetime.\n" unless $silent;
1288 "alter table branchtransfers change datearrived datearrived datetime");
1292 # changing the branchcategories table around...
1293 my %branchcategories;
1295 $sth = $dbh->prepare("show columns from branchcategories");
1297 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1299 $branchcategories{$column} = $type;
1302 unless ( $branchcategories{'categorycode'} eq 'varchar(4)' ) {
1304 "Setting type of categorycode in branchcategories to varchar(4),\n and making the primary key.\n" unless $silent;
1307 "alter table branchcategories change categorycode categorycode varchar(4) not null"
1312 "alter table branchcategories add primary key (categorycode)");
1316 unless ( $branchcategories{'categoryname'} eq 'text' ) {
1317 print "Changing branchcode in branchcategories to categoryname text.\n" unless $silent;
1320 "alter table branchcategories change branchcode categoryname text");
1324 unless ( $branchcategories{'codedescription'} eq 'text' ) {
1326 "Replacing branchholding in branchcategories with codedescription text.\n" unless $silent;
1329 "alter table branchcategories change branchholding codedescription text"
1334 # changing the items table around...
1337 $sth = $dbh->prepare("show columns from items");
1339 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1341 $items{$column} = $type;
1344 if ($items{'bulk'} eq "varchar(30)") {
1345 print " Setting callnumber in items table\n" unless $silent;
1347 $dbh->prepare("ALTER TABLE `items` CHANGE `bulk` `itemcallnumber` VARCHAR( 30 ) DEFAULT NULL");
1349 $sti = $dbh->prepare("update marc_subfield_structure set kohafield=\"items.itemcallnumber\" where kohafield=\"items.bulk\"");
1353 # changing the marc_subfield_structure table around...
1354 my %marc_subfield_structure;
1356 $sth = $dbh->prepare("show columns from marc_subfield_structure");
1358 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1360 $marc_subfield_structure{$column} = $type;
1363 if ($marc_subfield_structure{thesaurus_category}) {
1364 print " changing thesaurus_category in marc_subfield_structure table\n" unless $silent;
1366 $dbh->prepare("ALTER TABLE marc_subfield_structure CHANGE `thesaurus_category` `authtypecode` VARCHAR(10 ) DEFAULT NULL");
1371 # creating index in issuingrules if needed
1373 $sth = $dbh->prepare("show index from issuingrules");
1376 while ( my ( $table, $non_unique, $key_name, $Seq_in_index, $Column_name, $Collation, $cardinality, $sub_part, $Packed, $comment ) = $sth->fetchrow )
1378 if ($key_name eq 'PRIMARY') {
1382 print "Creating index on issuing rules\n" unless $exists or $silent;
1383 $dbh->do('ALTER TABLE issuingrules ADD PRIMARY KEY ( branchcode, categorycode, itemtype )') unless $exists;
1385 $dbh->do('ALTER TABLE marc_tag_structure drop primary key');
1386 $dbh->do('ALTER TABLE marc_tag_structure ADD PRIMARY KEY ( frameworkcode, tagfield )');
1388 $dbh->do('ALTER TABLE marc_subfield_structure drop primary key');
1389 $dbh->do('ALTER TABLE marc_subfield_structure ADD PRIMARY KEY ( frameworkcode, tagfield, tagsubfield )');
1391 # Get list of columns from marc_word table
1394 $sth = $dbh->prepare("show columns from marc_word");
1396 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1398 $marc_word{$column} = $type;
1399 $nullenabled{$column} = $null;
1401 if ($marc_word{subfieldid}) {
1402 #create field tagsubfield, copy tag+subfieldid, then drop tag and subfieldid
1403 print "Modifying marc_word (concat on tag and subfield for better perfs)\n" unless $silent;
1404 $dbh->do("ALTER TABLE `marc_word` ADD `tagsubfield` CHAR( 4 ) NOT NULL AFTER `bibid`");
1405 $dbh->do("update marc_word set tagsubfield=concat(tag,subfieldid)");
1406 $dbh->do("alter table marc_word drop tag");
1407 $dbh->do("alter table marc_word drop subfieldid");
1408 $dbh->do("create index Search_Marc on marc_word (tagsubfield,word)");
1410 # Populate tables with required data
1412 # fill aqbasket if it's empty and aqorder is not
1413 # => it means it has just been created & must be filled
1414 $sth = $dbh->prepare("select count(*) from aqbasket");
1416 if ($sth->fetchrow == 0) {
1417 $sth = $dbh->prepare("select count(*) from aqorders");
1419 if ($sth->fetchrow >0) {
1420 print "Populating new table aqbasket\n";
1421 print "IMPORTANT NOTE: error message \"Duplicate entry 'X' for key 1\" may appear. it should not be a real trouble\n";
1422 $sth=$dbh->prepare("select distinct basketno,booksellerid,authorisedby,entrydate,booksellerinvoicenumber from aqorders");
1424 my ($basketno,$booksellerid,$authorisedby,$entrydate,$booksellerinvoicenumber);
1425 my $sth2 = $dbh->prepare("insert into aqbasket (basketno,creationdate,booksellerid,authorisedby,booksellerinvoicenumber) values (?,?,?,?,?)");
1426 while (($basketno,$booksellerid,$authorisedby,$entrydate,$booksellerinvoicenumber) = $sth->fetchrow) {
1427 print "$basketno,$entrydate,$booksellerid,$authorisedby,$booksellerinvoicenumber\n";
1428 $sth2->execute($basketno,$entrydate,$booksellerid,$authorisedby,$booksellerinvoicenumber);
1432 foreach my $table ( keys %tabledata ) {
1433 print "Checking for data required in table $table...\n" unless $silent;
1434 my $tablerows = $tabledata{$table};
1435 foreach my $row (@$tablerows) {
1436 my $uniquefieldrequired = $row->{uniquefieldrequired};
1437 my $uniquevalue = $row->{$uniquefieldrequired};
1438 my $forceupdate = $row->{forceupdate};
1441 "select $uniquefieldrequired from $table where $uniquefieldrequired=?"
1443 $sth->execute($uniquevalue);
1445 foreach my $field (keys %$forceupdate) {
1446 if ($forceupdate->{$field}) {
1447 my $sth=$dbh->prepare("update systempreferences set $field=? where $uniquefieldrequired=?");
1448 $sth->execute($row->{$field}, $uniquevalue);
1452 print "Adding row to $table: " unless $silent;
1456 foreach my $field ( keys %$row ) {
1457 next if $field eq 'uniquefieldrequired';
1458 next if $field eq 'forceupdate';
1459 my $value = $row->{$field};
1460 push @values, $value;
1461 print " $field => $value" unless $silent;
1462 $fieldlist .= "$field,";
1463 $placeholders .= "?,";
1465 print "\n" unless $silent;
1466 $fieldlist =~ s/,$//;
1467 $placeholders =~ s/,$//;
1470 "insert into $table ($fieldlist) values ($placeholders)");
1471 $sth->execute(@values);
1476 # at last, remove useless fields
1477 foreach $table ( keys %uselessfields ) {
1478 my @fields = split /,/,$uselessfields{$table};
1481 foreach my $fieldtodrop (@fields) {
1482 $fieldtodrop =~ s/\t//g;
1483 $fieldtodrop =~ s/\n//g;
1485 $sth = $dbh->prepare("show columns from $table");
1487 while ( my ( $column, $type, $null, $key, $default, $extra ) = $sth->fetchrow )
1489 $exists =1 if ($column eq $fieldtodrop);
1492 print "deleting $fieldtodrop field in $table...\n" unless $silent;
1493 my $sth = $dbh->prepare("alter table $table drop $fieldtodrop");
1505 # Revision 1.106 2005/07/06 17:47:22 hdl
1506 # Add branch selection and filter for budgets and funds.
1507 # May be too much... Funds could be enough....
1509 # It works provided you update your base adding branchcode both in aqbookfund AND aqbudget.
1510 # If selection in budget is not needed, I shall remove.
1512 # Revision 1.105 2005/06/20 14:36:44 tipaul
1513 # synch'ing 2.2 and head
1515 # Revision 1.100.2.5 2005/06/06 15:23:36 tipaul
1516 # adding a systempref to choose either to show or hide "lost" items. Note that "lost items" can be related to an authorised value list, so does not necessary mean "item definetly lost". Even here, some libraries want to see lost items, and some don't want. This parameter will make everybody happy !
1518 # Revision 1.100.2.4 2005/06/06 14:15:55 tipaul
1519 # adding 2 systemparameters to define an alternate image as logo in opac (the image on main page & on each top-left page)
1521 # Revision 1.100.2.3 2005/06/02 21:05:34 hdl
1522 # adding variable SubscriptionHistory
1524 # Revision 1.100.2.2 2005/03/29 15:41:43 tipaul
1525 # * new permissions : management & tools. You now have 2 new permissions :
1526 # - management : means the user can manage library parameters, but NOT system parameters.
1527 # - parameters : means the user can manage all parameters (including system parameters : marc structure, authorised values, system preferences. Was the only flag previously existing)
1528 # - tools : means the user can import/export datas & edit barcodes.
1529 # note that for compatibility reasons, a user having "parameters" can access everything.
1530 # * new permission scheme. In every template new variables are available. They are written CAN_user_permission, with permission being one of the permission flag. templates can now show or hidde menu entries depending on user permissions. For example, a user with just circ permissions should have only the "circulation" button on home page. Templates are NOT updated in this version (except for system parameters, as proof of concept), they will be in the next ones. But the scheme is ready.
1532 # Revision 1.100.2.1 2005/03/17 17:15:18 tipaul
1533 # defaulting opacstylesheet to '' instead of 'normal' (that is stupid)
1535 # Revision 1.100 2004/12/10 16:11:32 tipaul
1536 # Improvement : adding a systempref to define default view in OPAC (either normal, MARC or ISBD). Created automatically during install or update. Check that you have a Koha >> parameters >> systempreferences >> BiblioDefaultView, Variable type : Choice, Variable options : normal|marc|isbd
1538 # Revision 1.99 2004/12/02 17:17:00 tipaul
1539 # adding acquisition permission
1541 # Revision 1.98 2004/11/26 20:26:49 tipaul
1542 # bugfix for auth_header creation
1544 # Revision 1.97 2004/11/23 09:11:08 tipaul
1545 # adding itemcallnumber entry
1547 # Revision 1.96 2004/11/16 13:03:45 tipaul
1548 # removing ldap systempref, it's now in C4/Auth_with_ldap.pm separate package
1550 # Revision 1.95 2004/11/08 19:57:32 tipaul
1553 # Revision 1.94 2004/09/06 10:00:29 tipaul
1554 # adding a "location" field to the library.
1555 # This field is useful when the callnumber contains no information on the room where the item is stored.
1556 # With this field, we now have 3 levels of informations to find a book :
1561 # This should be versatile enough to solve any storing method.
1562 # This hack is quite simple, due to the nice Biblio.pm API. The MARC => koha db link is automatically managed. Just add the link in the parameters section.
1564 # Revision 1.93 2004/08/12 14:50:50 tipaul
1567 # Revision 1.92 2004/08/06 16:38:42 tipaul
1568 # changing DB structure to calculate next issue number.
1569 # Seems to work fine.
1571 # Still misses the date calculation & the test of end of subscription (maybe for monday ?)
1573 # Revision 1.91 2004/07/15 09:52:28 tipaul
1574 # Acquisition & Suggestion :
1575 # * acquisition rewritte : create a aqbasket table to deal with "bookseller order header".
1576 # * add "close basket" feature : a closed basket can't be modified
1577 # * suggestion feature : manage suggestions in acquisition (after suggestion filled in OPAC)
1579 # Revision 1.90 2004/07/06 08:24:18 tipaul
1580 # adding 2 free fields that can be used for sorting purposes
1582 # Revision 1.89 2004/07/02 15:55:08 tipaul
1583 # Adding 2 new fields, called "sort1" and "sort2"
1584 # They can be used for sorting & statistics reasons by the library.
1586 # Revision 1.88 2004/06/26 23:34:26 rangi
1589 # Revision 1.87 2004/06/23 13:03:09 tipaul
1590 # fixes in DB structure
1592 # Revision 1.86 2004/06/22 11:30:57 tipaul
1593 # adding -s (silent) flag, to have a silent install.
1594 # only updater will be verbose
1596 # Revision 1.85 2004/06/17 15:19:44 tipaul
1597 # missing Marc_Search index on marc_word
1599 # Revision 1.84 2004/06/17 08:25:21 tipaul
1600 # DB modifs : merging tag & subfield in marc_word table
1602 # Revision 1.83 2004/06/10 08:32:02 tipaul
1603 # MARC authority management (continued)
1605 # Revision 1.82 2004/06/03 12:46:58 tipaul
1606 # * frameworks and itemtypes are independant
1608 # WARNING : will work only if applied to a 2.0 base. some modifs have been done since last commit that will NOT be applied if you run updatedatabase again.
1610 # Revision 1.81 2004/05/28 09:56:21 tipaul
1613 # Revision 1.80 2004/05/28 08:32:00 tipaul
1615 # * MARC authority file
1616 # * seealso & hidden in MARC biblio structure.
1618 # Revision 1.79 2004/05/18 09:50:07 tipaul
1619 # *** empty log message ***
1621 # Revision 1.78 2004/05/10 09:29:33 tipaul
1622 # css is now the default theme for OPAC.
1623 # It will be the theme used for improvements and new things in OPAC.
1625 # Revision 1.77 2004/05/06 14:56:51 tipaul
1626 # adding table issuingrules (previously called categoryitem
1628 # Revision 1.76 2004/05/03 09:32:25 tipaul
1629 # adding printcirculationsplit parameter (already existed, but was not in systempref by defaul)
1631 # Revision 1.75 2004/04/14 19:49:00 tipaul
1632 # seealso field set to 255 chars
1634 # Revision 1.74 2004/03/11 16:10:16 tipaul
1635 # *** empty log message ***
1637 # Revision 1.73 2004/03/06 20:26:13 tipaul
1638 # adding seealso feature in MARC searches