updater/updatedatabase

   1 #!/usr/bin/perl
   2
   3
   4 # Database Updater
   5 # This script checks for required updates to the database.
   6
   7 # Part of the Koha Library Software www.koha.org
   8 # Licensed under the GPL.
   9
  10 # Bugs/ToDo:
  11 # - Would also be a good idea to offer to do a backup at this time...
  12
  13 # NOTE:  If you do something more than once in here, make it table driven.
  14 use strict;
  15
  16 # CPAN modules
  17 use DBI;
  18 use Getopt::Long;
  19 # Koha modules
  20 use C4::Context;
  21
  22 use MARC::Record;
  23 use MARC::File::XML ( BinaryEncoding => 'utf8' );
  24
  25 # FIXME - The user might be installing a new database, so can't rely
  26 # on /etc/koha.conf anyway.
  27
  28 my $debug = 0;
  29
  30 my (
  31     $sth, $sti,
  32     $query,
  33     %existingtables,    # tables already in database
  34     %types,
  35     $table,
  36     $column,
  37     $type, $null, $key, $default, $extra,
  38     $prefitem,          # preference item in systempreferences table
  39 );
  40
  41 my $silent;
  42 GetOptions(
  43     's' =>\$silent
  44     );
  45 my $dbh = C4::Context->dbh;
  46 $|=1; # flushes output
  47
  48 =item
  49     Deal with virtualshelves
  50 =cut
  51
  52 my $DBversion = "3.00.00.001";
  53 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
  54     # update virtualshelves table to
  55     #
  56     $dbh->do("ALTER TABLE `bookshelf` RENAME `virtualshelves`");
  57     $dbh->do("ALTER TABLE `shelfcontents` RENAME `virtualshelfcontents`");
  58     $dbh->do("ALTER TABLE `virtualshelfcontents` ADD `biblionumber` INT( 11 ) NOT NULL");
  59     $dbh->do("UPDATE `virtualshelfcontents` SET biblionumber=(SELECT biblionumber FROM items WHERE items.itemnumber=virtualshelfcontents.itemnumber)");
  60     # drop all foreign keys : otherwise, we can't drop itemnumber field.
  61     DropAllForeignKeys('virtualshelfcontents');
  62     # create the new foreign keys (on biblionumber)
  63     $dbh->do("ALTER TABLE `virtualshelfcontents` ADD FOREIGN KEY biblionumber_fk (biblionumber) REFERENCES biblio (biblionumber) ON UPDATE CASCADE ON DELETE CASCADE");
  64     # re-create the foreign key on virtualshelf
  65     $dbh->do("ALTER TABLE `virtualshelfcontents` ADD FOREIGN KEY shelfnumber_fk (shelfnumber) REFERENCES virtualshelves (shelfnumber) ON UPDATE CASCADE ON DELETE CASCADE");
  66     # now we can drop the itemnumber column
  67     $dbh->do("ALTER TABLE `virtualshelfcontents` DROP `itemnumber`");
  68     print "Upgrade to $DBversion done (virtualshelves)\n";
  69     SetVersion ($DBversion);
  70 }
  71
  72
  73 $DBversion = "3.00.00.002";
  74 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
  75     $dbh->do("DROP TABLE sessions");
  76     $dbh->do("CREATE TABLE `sessions` (
  77   `id` char(32) NOT NULL,
  78   `a_session` text NOT NULL,
  79   UNIQUE KEY `id` (`id`)
  80 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;");
  81     print "Upgrade to $DBversion done (sessions uses CGI::session, new table structure for sessions)\n";
  82     SetVersion ($DBversion);
  83 }
  84
  85
  86 $DBversion = "3.00.00.003";
  87 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
  88     if (C4::Context->preference("opaclanguage") eq "fr") {
  89         $dbh->do("INSERT INTO `systempreferences` (variable,value,explanation,options,type) VALUES('ReservesNeedReturns','0','Si ce paramètre est mis à 1, une réservation posée sur un exemplaire présent sur le site devra être passée en retour pour être disponible. Sinon, elle sera automatiquement disponible, Koha considère que le bibliothécaire place la réservation en ayant le document en mains','','YesNo')");
  90     } else {
  91         $dbh->do("INSERT INTO `systempreferences` (variable,value,explanation,options,type) VALUES('ReservesNeedReturns','0','If set, a reserve done on an item available in this branch need a check-in, otherwise, a reserve on a specific item, that is on the branch & available is considered as available','','YesNo')");
  92     }
  93     print "Upgrade to $DBversion done (adding ReservesNeedReturns systempref, in circulation)\n";
  94     SetVersion ($DBversion);
  95 }
  96
  97
  98 $DBversion = "3.00.00.004";
  99 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
 100         $dbh->do("INSERT INTO `systempreferences` VALUES ('DebugLevel','2','set the level of error info sent to the browser. 0=none, 1=some, 2=most','0|1|2','Choice')");
 101     print "Upgrade to $DBversion done (adding DebugLevel systempref, in 'Admin' tab)\n";
 102     SetVersion ($DBversion);
 103 }
 104
 105 $DBversion = "3.00.00.005";
 106 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
 107         $dbh->do("CREATE TABLE `tags` (
 108                     `entry` varchar(255) NOT NULL default '',
 109                     `weight` bigint(20) NOT NULL default 0,
 110                     PRIMARY KEY  (`entry`)
 111                     ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 112                 ");
 113         $dbh->do("CREATE TABLE `nozebra` (
 114                 `server` varchar(20)     NOT NULL,
 115                 `indexname` varchar(40)  NOT NULL,
 116                 `value` varchar(250)     NOT NULL,
 117                 `biblionumbers` longtext NOT NULL,
 118                 KEY `indexname` (`server`,`indexname`),
 119                 KEY `value` (`server`,`value`))
 120                 ENGINE=InnoDB DEFAULT CHARSET=utf8;
 121                 ");
 122     print "Upgrade to $DBversion done (adding tags and nozebra tables )\n";
 123     SetVersion ($DBversion);
 124 }
 125
 126 $DBversion = "3.00.00.006";
 127 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
 128         $dbh->do("UPDATE issues SET issuedate=timestamp WHERE issuedate='0000-00-00'");
 129     print "Upgrade to $DBversion done (filled issues.issuedate with timestamp)\n";
 130     SetVersion ($DBversion);
 131 }
 132
 133 $DBversion = "3.00.00.007";
 134 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
 135         $dbh->do("INSERT INTO systempreferences (variable,value,explanation,options,type) VALUES ('SessionStorage','mysql','Use mysql or a temporary file for storing session data','mysql|tmp','Choice')");
 136     print "Upgrade to $DBversion done (set SessionStorage variable)\n";
 137     SetVersion ($DBversion);
 138 }
 139
 140 $DBversion = "3.00.00.008";
 141 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
 142         $dbh->do("ALTER TABLE `biblio` ADD `datecreated` DATE NOT NULL AFTER `timestamp` ;");
 143         $dbh->do("UPDATE biblio SET datecreated=timestamp");
 144     print "Upgrade to $DBversion done (biblio creation date)\n";
 145     SetVersion ($DBversion);
 146 }
 147
 148 $DBversion = "3.00.00.009";
 149 if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
 150
 151     # Create backups of call number columns
 152     # in case default migration needs to be customized
 153     #
 154     # UPGRADE NOTE: temp_upg_biblioitems_call_num should be dropped
 155     #               after call numbers have been transformed to the new structure
 156     #
 157     # Not bothering to do the same with deletedbiblioitems -- assume
 158     # default is good enough.
 159     $dbh->do("CREATE TABLE `temp_upg_biblioitems_call_num` AS
 160               SELECT `biblioitemnumber`, `biblionumber`,
 161                      `classification`, `dewey`, `subclass`,
 162                      `lcsort`, `ccode`
 163               FROM `biblioitems`");
 164
 165     # biblioitems changes
 166     $dbh->do("ALTER TABLE `biblioitems` CHANGE COLUMN `volumeddesc` `volumedesc` TEXT");
 167     $dbh->do("ALTER TABLE `biblioitems` ADD `cn_source` VARCHAR(10) DEFAULT NULL AFTER `ccode`");
 168     $dbh->do("ALTER TABLE `biblioitems` ADD `cn_class` VARCHAR(30) DEFAULT NULL AFTER `cn_source`");
 169     $dbh->do("ALTER TABLE `biblioitems` ADD `cn_item` VARCHAR(10) DEFAULT NULL AFTER `cn_class`");
 170     $dbh->do("ALTER TABLE `biblioitems` ADD `cn_suffix` VARCHAR(10) DEFAULT NULL AFTER `cn_item`");
 171     $dbh->do("ALTER TABLE `biblioitems` ADD `cn_sort` VARCHAR(30) DEFAULT NULL AFTER `cn_suffix`");
 172     $dbh->do("ALTER TABLE `biblioitems` ADD `totalissues` INT(10) AFTER `cn_sort`");
 173
 174     # default mapping of call number columns:
 175     #   cn_class = concatentation of classification + dewey,
 176     #              trimmed to fit -- assumes that most users do not
 177     #              populate both classification and dewey in a single record
 178     #   cn_item  = subclass
 179     #   cn_source = left null
 180     #   cn_sort = lcsort
 181     #
 182     # After upgrade, cn_sort will have to be set based on whatever
 183     # default call number scheme user sets as a preference.  Misc
 184     # script will be added at some point to do that.
 185     #
 186     $dbh->do("UPDATE `biblioitems`
 187               SET cn_class = SUBSTR(TRIM(CONCAT_WS(' ', `classification`, `dewey`)), 1, 30)");
 188     $dbh->do("UPDATE `biblioitems` SET cn_item = subclass");
 189     $dbh->do("UPDATE `biblioitems` SET `cn_sort` = `lcsort`");
 190
 191     # Now drop the old call number columns
 192     $dbh->do("ALTER TABLE `biblioitems` DROP COLUMN `classification`");
 193     $dbh->do("ALTER TABLE `biblioitems` DROP COLUMN `dewey`");
 194     $dbh->do("ALTER TABLE `biblioitems` DROP COLUMN `subclass`");
 195     $dbh->do("ALTER TABLE `biblioitems` DROP COLUMN `lcsort`");
 196     $dbh->do("ALTER TABLE `biblioitems` DROP COLUMN `ccode`");
 197
 198     # deletedbiblio changes
 199     $dbh->do("ALTER TABLE `deletedbiblio` ALTER COLUMN `frameworkcode` SET DEFAULT ''");
 200     $dbh->do("ALTER TABLE `deletedbiblio` DROP COLUMN `marc`");
 201     $dbh->do("ALTER TABLE `deletedbiblio` ADD `datecreated` DATE NOT NULL AFTER `timestamp`");
 202     $dbh->do("UPDATE deletedbiblio SET datecreated = timestamp");
 203
 204     # deletedbiblioitems changes
 205     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `publicationyear` TEXT");
 206     $dbh->do("ALTER TABLE `deletedbiblioitems` CHANGE `volumeddesc` `volumedesc` TEXT");
 207     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `collectiontitle` MEDIUMTEXT DEFAULT NULL AFTER `volumedesc`");
 208     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `collectionissn` TEXT DEFAULT NULL AFTER `collectiontitle`");
 209     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `collectionvolume` MEDIUMTEXT DEFAULT NULL AFTER `collectionissn`");
 210     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `editionstatement` TEXT DEFAULT NULL AFTER `collectionvolume`");
 211     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `editionresponsibility` TEXT DEFAULT NULL AFTER `editionstatement`");
 212     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `place` VARCHAR(255) DEFAULT NULL AFTER `size`");
 213     $dbh->do("ALTER TABLE `deletedbiblioitems` MODIFY `marc` BLOB");
 214     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD `cn_source` VARCHAR(10) DEFAULT NULL AFTER `url`");
 215     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD `cn_class` VARCHAR(30) DEFAULT NULL AFTER `cn_source`");
 216     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD `cn_item` VARCHAR(10) DEFAULT NULL AFTER `cn_class`");
 217     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD `cn_suffix` VARCHAR(10) DEFAULT NULL AFTER `cn_item`");
 218     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD `cn_sort` VARCHAR(30) DEFAULT NULL AFTER `cn_suffix`");
 219     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD `totalissues` INT(10) AFTER `cn_sort`");
 220     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD KEY `isbn` (`isbn`)");
 221     $dbh->do("ALTER TABLE `deletedbiblioitems` ADD KEY `publishercode` (`publishercode`)");
 222
 223     $dbh->do("UPDATE `deletedbiblioitems`
 224               SET cn_class = SUBSTR(TRIM(CONCAT_WS(' ', `classification`, `dewey`)), 1, 30)");
 225     $dbh->do("UPDATE `deletedbiblioitems` SET cn_item = subclass");
 226     $dbh->do("UPDATE `deletedbiblioitems` SET `cn_sort` = `lcsort`");
 227     $dbh->do("ALTER TABLE `deletedbiblioitems` DROP COLUMN `classification`");
 228     $dbh->do("ALTER TABLE `deletedbiblioitems` DROP COLUMN `dewey`");
 229     $dbh->do("ALTER TABLE `deletedbiblioitems` DROP COLUMN `subclass`");
 230     $dbh->do("ALTER TABLE `deletedbiblioitems` DROP COLUMN `lcsort`");
 231     $dbh->do("ALTER TABLE `deletedbiblioitems` DROP COLUMN `ccode`");
 232
 233     # deleteditems changes
 234     $dbh->do("ALTER TABLE `deleteditems` MODIFY `barcode` VARCHAR(20) DEFAULT NULL");
 235     $dbh->do("ALTER TABLE `deleteditems` MODIFY `price` DECIMAL(8,2) DEFAULT NULL");
 236     $dbh->do("ALTER TABLE `deleteditems` MODIFY `replacementprice` DECIMAL(8,2) DEFAULT NULL");
 237     $dbh->do("ALTER TABLE `deleteditems` DROP `bulk`");
 238     $dbh->do("ALTER TABLE `deleteditems` MODIFY `itemcallnumber` VARCHAR(30) DEFAULT NULL AFTER `wthdrawn`");
 239     $dbh->do("ALTER TABLE `deleteditems` MODIFY `holdingbranch` VARCHAR(10) DEFAULT NULL");
 240     $dbh->do("ALTER TABLE `deleteditems` DROP `interim`");
 241     $dbh->do("ALTER TABLE `deleteditems` MODIFY `timestamp` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP AFTER `paidfor`");
 242     $dbh->do("ALTER TABLE `deleteditems` DROP `cutterextra`");
 243     $dbh->do("ALTER TABLE `deleteditems` ADD `cn_source` VARCHAR(10) DEFAULT NULL AFTER `onloan`");
 244     $dbh->do("ALTER TABLE `deleteditems` ADD `cn_sort` VARCHAR(30) DEFAULT NULL AFTER `cn_source");
 245     $dbh->do("ALTER TABLE `deleteditems` ADD `ccode` VARCHAR(10) DEFAULT NULL AFTER `cn_sort`");
 246     $dbh->do("ALTER TABLE `deleteditems` ADD `materials` VARCHAR(10) DEFAULT NULL AFTER `ccode`");
 247     $dbh->do("ALTER TABLE `deleteditems` ADD `uri` VARCHAR(255) DEFAULT NULL AFTER `materials`");
 248     $dbh->do("ALTER TABLE `deleteditems` MODIFY `marc` LONGBLOB AFTER `uri`");
 249     $dbh->do("ALTER TABLE `deleteditems` DROP KEY `barcode`");
 250     $dbh->do("ALTER TABLE `deleteditems` DROP KEY `itembarcodeidx`");
 251     $dbh->do("ALTER TABLE `deleteditems` DROP KEY `itembinoidx`");
 252     $dbh->do("ALTER TABLE `deleteditems` DROP KEY `itembibnoidx`");
 253     $dbh->do("ALTER TABLE `deleteditems` ADD UNIQUE KEY `delitembarcodeidx` (`barcode`)");
 254     $dbh->do("ALTER TABLE `deleteditems` ADD KEY `delitembinoidx` (`biblioitemnumber`)");
 255     $dbh->do("ALTER TABLE `deleteditems` ADD KEY `delitembibnoidx` (`biblionumber`)");
 256     $dbh->do("ALTER TABLE `deleteditems` ADD KEY `delhomebranch` (`homebranch`)");
 257     $dbh->do("ALTER TABLE `deleteditems` ADD KEY `delholdingbranch` (`holdingbranch`)");
 258     $dbh->do("UPDATE `deleteditems` SET `ccode` = `itype`");
 259     $dbh->do("ALTER TABLE `deleteditems` DROP `itype`");
 260     $dbh->do("UPDATE `deleteditems` SET `cn_sort` = `itemcallnumber`");
 261
 262     # items changes
 263     $dbh->do("ALTER TABLE `items` ADD `cn_source` VARCHAR(10) DEFAULT NULL AFTER `onloan`");
 264     $dbh->do("ALTER TABLE `items` ADD `cn_sort` VARCHAR(30) DEFAULT NULL AFTER `cn_source");
 265     $dbh->do("ALTER TABLE `items` ADD `ccode` VARCHAR(10) DEFAULT NULL AFTER `cn_sort`");
 266     $dbh->do("ALTER TABLE `items` ADD `materials` VARCHAR(10) DEFAULT NULL AFTER `ccode`");
 267     $dbh->do("ALTER TABLE `items` ADD `uri` VARCHAR(255) DEFAULT NULL AFTER `materials`");
 268     $dbh->do("ALTER TABLE `items` DROP KEY `itembarcodeidx`");
 269     $dbh->do("ALTER TABLE `items` ADD UNIQUE KEY `itembarcodeidx` (`barcode`)");
 270
 271     # map items.itype to items.ccode
 272     $dbh->do("UPDATE `items` SET `ccode` = `itype`");
 273
 274     # set cn_sort to itemcallnumber -- as with biblioitems.cn_sort,
 275     # will have to be subsequently updated per user's default
 276     # classification scheme
 277     $dbh->do("UPDATE `items` SET `cn_sort` = `itemcallnumber`");
 278
 279     $dbh->do("ALTER TABLE `items` DROP `cutterextra`");
 280     $dbh->do("ALTER TABLE `items` DROP `itype`");
 281
 282     print "Upgrade to $DBversion done (major changes to biblio, biblioitems, items, and deleted* versions of same\n";
 283     SetVersion ($DBversion);
 284 }
 285
 286 =item DropAllForeignKeys($table)
 287
 288   Drop all foreign keys of the table $table
 289
 290 =cut
 291
 292 sub DropAllForeignKeys {
 293     my ($table) = @_;
 294     # get the table description
 295     my $sth = $dbh->prepare("SHOW CREATE TABLE $table");
 296     $sth->execute;
 297     my $vsc_structure = $sth->fetchrow;
 298     # split on CONSTRAINT keyword
 299     my @fks = split /CONSTRAINT /,$vsc_structure;
 300     # parse each entry
 301     foreach (@fks) {
 302         # isolate what is before FOREIGN KEY, if there is something, it's a foreign key to drop
 303         $_ = /(.*) FOREIGN KEY.*/;
 304         my $id = $1;
 305         if ($id) {
 306             # we have found 1 foreign, drop it
 307             $dbh->do("ALTER TABLE $table DROP FOREIGN KEY $id");
 308             $id="";
 309         }
 310     }
 311 }
 312
 313
 314
 315
 316
 317
 318
 319 =item TransformToNum
 320
 321   Transform the Koha version from a 4 parts string
 322   to a number, with just 1 .
 323
 324 =cut
 325
 326 sub TransformToNum {
 327     my $version = shift;
 328     # remove the 3 last . to have a Perl number
 329     $version =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 330     return $version;
 331 }
 332
 333 =item SetVersion
 334     set the DBversion in the systempreferences
 335 =cut
 336
 337 sub SetVersion {
 338     my $kohaversion = TransformToNum(shift);
 339     if (C4::Context->preference('Version')) {
 340       my $finish=$dbh->prepare("UPDATE systempreferences SET value=? WHERE variable='Version'");
 341       $finish->execute($kohaversion);
 342     } else {
 343       my $finish=$dbh->prepare("INSERT into systempreferences (variable,value,explanation) values ('Version',?,'The Koha database version. Don t change this value manually, it s holded by the webinstaller')");
 344       $finish->execute($kohaversion);
 345     }
 346 }
 347 exit;
 348
 349 # Revision 1.172  2007/07/19 10:21:22  hdl