[15699] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
[21411] | 3 | # dbutil.pm -- gateway to utilities for reading/writing to different databases
|
---|
[15699] | 4 | # Copyright (C) 2008 DL Consulting Ltd
|
---|
| 5 | #
|
---|
| 6 | # A component of the Greenstone digital library software
|
---|
| 7 | # from the New Zealand Digital Library Project at the
|
---|
| 8 | # University of Waikato, New Zealand.
|
---|
| 9 | #
|
---|
| 10 | # This program is free software; you can redistribute it and/or modify
|
---|
| 11 | # it under the terms of the GNU General Public License as published by
|
---|
| 12 | # the Free Software Foundation; either version 2 of the License, or
|
---|
| 13 | # (at your option) any later version.
|
---|
| 14 | #
|
---|
| 15 | # This program is distributed in the hope that it will be useful,
|
---|
| 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 18 | # GNU General Public License for more details.
|
---|
| 19 | #
|
---|
| 20 | # You should have received a copy of the GNU General Public License
|
---|
| 21 | # along with this program; if not, write to the Free Software
|
---|
| 22 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 23 | #
|
---|
| 24 | ###########################################################################
|
---|
| 25 |
|
---|
| 26 | package dbutil;
|
---|
| 27 |
|
---|
| 28 | use strict;
|
---|
| 29 |
|
---|
| 30 |
|
---|
[17087] | 31 | sub open_infodb_write_handle
|
---|
| 32 | {
|
---|
[17476] | 33 | my $infodb_type = shift(@_);
|
---|
| 34 | my $infodb_file_path = shift(@_);
|
---|
| 35 |
|
---|
| 36 | if ($infodb_type eq "sqlite")
|
---|
| 37 | {
|
---|
[21544] | 38 | require dbutil::sqlite;
|
---|
[21546] | 39 | return &dbutil::sqlite::open_infodb_write_handle($infodb_file_path, @_);
|
---|
[17476] | 40 | }
|
---|
| 41 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 42 | {
|
---|
[21544] | 43 | require dbutil::gdbmtxtgz;
|
---|
[21546] | 44 | return &dbutil::gdbmtxtgz::open_infodb_write_handle($infodb_file_path, @_);
|
---|
[17476] | 45 | }
|
---|
[21411] | 46 | elsif ($infodb_type eq "jdbm")
|
---|
| 47 | {
|
---|
[21544] | 48 | require dbutil::jdbm;
|
---|
[21546] | 49 | return &dbutil::jdbm::open_infodb_write_handle($infodb_file_path, @_);
|
---|
[21411] | 50 | }
|
---|
[17476] | 51 | elsif ($infodb_type eq "mssql")
|
---|
| 52 | {
|
---|
[21544] | 53 | require dbutil::mssql;
|
---|
[21546] | 54 | return &dbutil::mssql::open_infodb_write_handle($infodb_file_path, @_);
|
---|
[17476] | 55 | }
|
---|
[17087] | 56 |
|
---|
[17476] | 57 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
[21544] | 58 | require dbutil::gdbm;
|
---|
[21546] | 59 | return &dbutil::gdbm::open_infodb_write_handle($infodb_file_path, @_);
|
---|
[17087] | 60 | }
|
---|
| 61 |
|
---|
| 62 |
|
---|
[16176] | 63 | sub close_infodb_write_handle
|
---|
| 64 | {
|
---|
[17476] | 65 | my $infodb_type = shift(@_);
|
---|
| 66 | my $infodb_handle = shift(@_);
|
---|
[16176] | 67 |
|
---|
[17476] | 68 | if ($infodb_type eq "sqlite")
|
---|
| 69 | {
|
---|
[21544] | 70 | require dbutil::sqlite;
|
---|
[21546] | 71 | return &dbutil::sqlite::close_infodb_write_handle($infodb_handle, @_);
|
---|
[17476] | 72 | }
|
---|
| 73 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 74 | {
|
---|
[21544] | 75 | require dbutil::gdbmtxtgz;
|
---|
[21546] | 76 | return &dbutil::gdbmtxtgz::close_infodb_write_handle($infodb_handle, @_);
|
---|
[17476] | 77 | }
|
---|
[21411] | 78 | elsif ($infodb_type eq "jdbm")
|
---|
| 79 | {
|
---|
[21544] | 80 | require dbutil::jdbm;
|
---|
[21546] | 81 | return &dbutil::jdbm::close_infodb_write_handle($infodb_handle, @_);
|
---|
[21411] | 82 | }
|
---|
[17476] | 83 | elsif ($infodb_type eq "mssql")
|
---|
| 84 | {
|
---|
[21544] | 85 | require dbutil::mssql;
|
---|
[21546] | 86 | return &dbutil::mssql::close_infodb_write_handle($infodb_handle, @_);
|
---|
[17476] | 87 | }
|
---|
| 88 |
|
---|
| 89 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
[21544] | 90 | require dbutil::gdbm;
|
---|
[21546] | 91 | return &dbutil::gdbm::close_infodb_write_handle($infodb_handle, @_);
|
---|
[17104] | 92 | }
|
---|
[16176] | 93 |
|
---|
| 94 |
|
---|
[15727] | 95 | sub get_default_infodb_type
|
---|
| 96 | {
|
---|
[17476] | 97 | # The default is GDBM so everything works the same for existing collections
|
---|
| 98 | # To use something else, specify the "infodbtype" in the collection's collect.cfg file
|
---|
| 99 | return "gdbm";
|
---|
[15727] | 100 | }
|
---|
| 101 |
|
---|
| 102 |
|
---|
[15710] | 103 | sub get_infodb_file_path
|
---|
| 104 | {
|
---|
[17476] | 105 | my $infodb_type = shift(@_);
|
---|
| 106 | my $collection_name = shift(@_);
|
---|
| 107 | my $infodb_directory_path = shift(@_);
|
---|
[15710] | 108 |
|
---|
[17476] | 109 | if ($infodb_type eq "sqlite")
|
---|
| 110 | {
|
---|
[21544] | 111 | require dbutil::sqlite;
|
---|
[21546] | 112 | return &dbutil::sqlite::get_infodb_file_path($collection_name, $infodb_directory_path, @_);
|
---|
[17476] | 113 | }
|
---|
| 114 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 115 | {
|
---|
[21544] | 116 | require dbutil::gdbmtxtgz;
|
---|
[21546] | 117 | return &dbutil::gdbmtxtgz::get_infodb_file_path($collection_name, $infodb_directory_path, @_);
|
---|
[17476] | 118 | }
|
---|
[21411] | 119 | elsif ($infodb_type eq "jdbm")
|
---|
| 120 | {
|
---|
[21544] | 121 | require dbutil::jdbm;
|
---|
[21546] | 122 | return &dbutil::jdbm::get_infodb_file_path($collection_name, $infodb_directory_path, @_);
|
---|
[21411] | 123 | }
|
---|
[17476] | 124 | elsif ($infodb_type eq "mssql")
|
---|
| 125 | {
|
---|
| 126 | #==================================================================================================#
|
---|
| 127 | # Updated by Jeffrey (2008/08/25 Monday)
|
---|
| 128 | # After look into the run-time code, it seems we should still create a database file.
|
---|
| 129 | # Since the run-time code is always try to read a database file, the easiest way here is not
|
---|
| 130 | # to change the whole structure, but to give whatever the system is looking for.
|
---|
| 131 | #==================================================================================================#
|
---|
| 132 | # Added by Jeffrey (2008/08/15 Friday)
|
---|
| 133 | # No file path required for MS SQL, it is a server-client connection.
|
---|
[21411] | 134 | # At the moment the information is hard coded in dbutil::mssql::open_infodb_write_handle
|
---|
[17476] | 135 | # the this might need some tidy up sometime.
|
---|
| 136 | #==================================================================================================#
|
---|
[21544] | 137 | require dbutil::mssql;
|
---|
[21546] | 138 | return &dbutil::mssql::get_infodb_file_path($collection_name, $infodb_directory_path, @_);
|
---|
[17476] | 139 | }
|
---|
| 140 |
|
---|
| 141 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
[21544] | 142 | require dbutil::gdbm;
|
---|
[21546] | 143 | return &dbutil::gdbm::get_infodb_file_path($collection_name, $infodb_directory_path, @_);
|
---|
[15710] | 144 | }
|
---|
| 145 |
|
---|
[22485] | 146 | # This function, conceptually, would be better structured if it didn't
|
---|
| 147 | # use return statements, as the database methods it calls do not
|
---|
| 148 | # themselves return anything.
|
---|
| 149 | # Note: if doing this, then the GDBM lines of code should be moved into
|
---|
| 150 | # an 'else' clause
|
---|
[15710] | 151 |
|
---|
[15705] | 152 | sub read_infodb_file
|
---|
| 153 | {
|
---|
[17476] | 154 | my $infodb_type = shift(@_);
|
---|
| 155 | my $infodb_file_path = shift(@_);
|
---|
| 156 | my $infodb_map = shift(@_);
|
---|
[15705] | 157 |
|
---|
[17476] | 158 | if ($infodb_type eq "sqlite")
|
---|
| 159 | {
|
---|
[21544] | 160 | require dbutil::sqlite;
|
---|
[21546] | 161 | return &dbutil::sqlite::read_infodb_file($infodb_file_path, $infodb_map, @_);
|
---|
[17476] | 162 | }
|
---|
| 163 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 164 | {
|
---|
[21544] | 165 | require dbutil::gdbmtxtgz;
|
---|
[21546] | 166 | return &dbutil::gdbmtxtgz::read_infodb_file($infodb_file_path, $infodb_map, @_);
|
---|
[17476] | 167 | }
|
---|
[21411] | 168 | elsif ($infodb_type eq "jdbm")
|
---|
| 169 | {
|
---|
[21544] | 170 | require dbutil::jdbm;
|
---|
[21546] | 171 | return &dbutil::jdbm::read_infodb_file($infodb_file_path, $infodb_map, @_);
|
---|
[21411] | 172 | }
|
---|
[17476] | 173 | elsif ($infodb_type eq "mssql")
|
---|
| 174 | {
|
---|
[21544] | 175 | require dbutil::mssql;
|
---|
[21546] | 176 | return &dbutil::mssql::read_infodb_file($infodb_file_path, $infodb_map, @_);
|
---|
[17476] | 177 | }
|
---|
| 178 |
|
---|
| 179 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
[21544] | 180 | require dbutil::gdbm;
|
---|
[21546] | 181 | return &dbutil::gdbm::read_infodb_file($infodb_file_path, $infodb_map, @_);
|
---|
[15705] | 182 | }
|
---|
| 183 |
|
---|
[22485] | 184 | sub read_infodb_keys
|
---|
| 185 | {
|
---|
| 186 | my $infodb_type = shift(@_);
|
---|
| 187 | my $infodb_file_path = shift(@_);
|
---|
| 188 | my $infodb_map = shift(@_);
|
---|
| 189 |
|
---|
| 190 | if ($infodb_type eq "sqlite")
|
---|
| 191 | {
|
---|
| 192 | require dbutil::sqlite;
|
---|
| 193 | &dbutil::sqlite::read_infodb_keys($infodb_file_path, $infodb_map, @_);
|
---|
| 194 | }
|
---|
| 195 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 196 | {
|
---|
| 197 | require dbutil::gdbmtxtgz;
|
---|
| 198 | &dbutil::gdbmtxtgz::read_infodb_keys($infodb_file_path, $infodb_map, @_);
|
---|
| 199 | }
|
---|
| 200 | elsif ($infodb_type eq "jdbm")
|
---|
| 201 | {
|
---|
| 202 | require dbutil::jdbm;
|
---|
| 203 | &dbutil::jdbm::read_infodb_keys($infodb_file_path, $infodb_map, @_);
|
---|
| 204 | }
|
---|
| 205 | elsif ($infodb_type eq "mssql")
|
---|
| 206 | {
|
---|
| 207 | require dbutil::mssql;
|
---|
| 208 | &dbutil::mssql::read_infodb_keys($infodb_file_path, $infodb_map, @_);
|
---|
| 209 | }
|
---|
| 210 | else {
|
---|
| 211 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
| 212 | require dbutil::gdbm;
|
---|
| 213 | &dbutil::gdbm::read_infodb_keys($infodb_file_path, $infodb_map, @_);
|
---|
| 214 | }
|
---|
| 215 | }
|
---|
[15705] | 216 |
|
---|
[21547] | 217 | sub read_infodb_entry
|
---|
| 218 | {
|
---|
| 219 | my $infodb_type = shift(@_);
|
---|
| 220 | my $infodb_file_path = shift(@_);
|
---|
| 221 | my $infodb_key = shift(@_);
|
---|
| 222 |
|
---|
| 223 | # !! TEMPORARY: Slow and naive implementation that just reads the entire file and picks out the one value
|
---|
| 224 | # !! This will soon be replaced with database-specific versions that will use dbget etc.
|
---|
| 225 | my $infodb_map = {};
|
---|
| 226 | &read_infodb_file($infodb_type, $infodb_file_path, $infodb_map);
|
---|
| 227 | return $infodb_map->{$infodb_key};
|
---|
| 228 | }
|
---|
| 229 |
|
---|
| 230 |
|
---|
[15699] | 231 | sub write_infodb_entry
|
---|
| 232 | {
|
---|
[17476] | 233 | my $infodb_type = shift(@_);
|
---|
| 234 | my $infodb_handle = shift(@_);
|
---|
| 235 | my $infodb_key = shift(@_);
|
---|
| 236 | my $infodb_map = shift(@_);
|
---|
[15699] | 237 |
|
---|
[17476] | 238 | if ($infodb_type eq "sqlite")
|
---|
| 239 | {
|
---|
[21544] | 240 | require dbutil::sqlite;
|
---|
[21546] | 241 | return &dbutil::sqlite::write_infodb_entry($infodb_handle, $infodb_key, $infodb_map, @_);
|
---|
[17476] | 242 | }
|
---|
| 243 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 244 | {
|
---|
[21544] | 245 | require dbutil::gdbmtxtgz;
|
---|
[21546] | 246 | return &dbutil::gdbmtxtgz::write_infodb_entry($infodb_handle, $infodb_key, $infodb_map, @_);
|
---|
[17476] | 247 | }
|
---|
[21411] | 248 | elsif ($infodb_type eq "jdbm")
|
---|
| 249 | {
|
---|
[21544] | 250 | require dbutil::jdbm;
|
---|
[21546] | 251 | return &dbutil::jdbm::write_infodb_entry($infodb_handle, $infodb_key, $infodb_map, @_);
|
---|
[21411] | 252 | }
|
---|
[17476] | 253 | elsif ($infodb_type eq "mssql")
|
---|
| 254 | {
|
---|
[21544] | 255 | require dbutil::mssql;
|
---|
[21546] | 256 | return &dbutil::mssql::write_infodb_entry($infodb_handle, $infodb_key, $infodb_map, @_);
|
---|
[17476] | 257 | }
|
---|
[15725] | 258 |
|
---|
[17476] | 259 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
[21544] | 260 | require dbutil::gdbm;
|
---|
[21546] | 261 | return &dbutil::gdbm::write_infodb_entry($infodb_handle, $infodb_key, $infodb_map, @_);
|
---|
[15699] | 262 | }
|
---|
| 263 |
|
---|
[15705] | 264 |
|
---|
[21856] | 265 | sub write_infodb_rawentry
|
---|
| 266 | {
|
---|
| 267 | my $infodb_type = shift(@_);
|
---|
| 268 | my $infodb_handle = shift(@_);
|
---|
| 269 | my $infodb_key = shift(@_);
|
---|
| 270 | my $infodb_val = shift(@_);
|
---|
| 271 |
|
---|
| 272 | if ($infodb_type eq "sqlite")
|
---|
| 273 | {
|
---|
| 274 | require dbutil::sqlite;
|
---|
| 275 | return &dbutil::sqlite::write_infodb_rawentry($infodb_handle, $infodb_key, $infodb_val, @_);
|
---|
| 276 | }
|
---|
| 277 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 278 | {
|
---|
| 279 | require dbutil::gdbmtxtgz;
|
---|
| 280 | return &dbutil::gdbmtxtgz::write_infodb_rawentry($infodb_handle, $infodb_key, $infodb_val, @_);
|
---|
| 281 | }
|
---|
| 282 | elsif ($infodb_type eq "jdbm")
|
---|
| 283 | {
|
---|
| 284 | require dbutil::jdbm;
|
---|
| 285 | return &dbutil::jdbm::write_infodb_rawentry($infodb_handle, $infodb_key, $infodb_val, @_);
|
---|
| 286 | }
|
---|
| 287 | elsif ($infodb_type eq "mssql")
|
---|
| 288 | {
|
---|
| 289 | require dbutil::mssql;
|
---|
| 290 | return &dbutil::mssql::write_infodb_rawentry($infodb_handle, $infodb_key, $infodb_val, @_);
|
---|
| 291 | }
|
---|
| 292 |
|
---|
| 293 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
| 294 | require dbutil::gdbm;
|
---|
| 295 | return &dbutil::gdbm::write_infodb_rawentry($infodb_handle, $infodb_key, $infodb_val, @_);
|
---|
| 296 | }
|
---|
| 297 |
|
---|
| 298 |
|
---|
| 299 |
|
---|
[18467] | 300 | sub delete_infodb_entry
|
---|
| 301 | {
|
---|
| 302 | my $infodb_type = shift(@_);
|
---|
| 303 | my $infodb_handle = shift(@_);
|
---|
| 304 | my $infodb_key = shift(@_);
|
---|
[15705] | 305 |
|
---|
[18467] | 306 | if ($infodb_type eq "sqlite")
|
---|
| 307 | {
|
---|
[21544] | 308 | require dbutil::sqlite;
|
---|
[21546] | 309 | return &dbutil::sqlite::delete_infodb_entry($infodb_handle, $infodb_key, @_);
|
---|
[18467] | 310 | }
|
---|
| 311 | elsif ($infodb_type eq "gdbm-txtgz")
|
---|
| 312 | {
|
---|
[21544] | 313 | require dbutil::gdbmtxtgz;
|
---|
[21546] | 314 | return &dbutil::gdbmtxtgz::delete_infodb_entry($infodb_handle, $infodb_key, @_);
|
---|
[18467] | 315 | }
|
---|
[21411] | 316 | elsif ($infodb_type eq "jdbm")
|
---|
| 317 | {
|
---|
[21544] | 318 | require dbutil::jdbm;
|
---|
[21546] | 319 | return &dbutil::jdbm::delete_infodb_entry($infodb_handle, $infodb_key, @_);
|
---|
[21411] | 320 | }
|
---|
[18467] | 321 | elsif ($infodb_type eq "mssql")
|
---|
| 322 | {
|
---|
[21544] | 323 | require dbutil::mssql;
|
---|
[21546] | 324 | return &dbutil::mssql::delete_infodb_entry($infodb_handle, $infodb_key, @_);
|
---|
[18467] | 325 | }
|
---|
| 326 |
|
---|
| 327 | # Use GDBM if the infodb type is empty or not one of the values above
|
---|
[21544] | 328 | require dbutil::gdbm;
|
---|
[21546] | 329 | return &dbutil::gdbm::delete_infodb_entry($infodb_handle, $infodb_key, @_);
|
---|
[18467] | 330 | }
|
---|
| 331 |
|
---|
| 332 |
|
---|
[21550] | 333 | # ---- GENERAL FUNCTIONS --------
|
---|
| 334 |
|
---|
| 335 | sub convert_infodb_hash_to_string
|
---|
| 336 | {
|
---|
| 337 | my $infodb_map = shift(@_);
|
---|
| 338 |
|
---|
| 339 | my $infodb_entry_value = "";
|
---|
| 340 | foreach my $infodb_value_key (keys(%$infodb_map))
|
---|
| 341 | {
|
---|
| 342 | foreach my $infodb_value (@{$infodb_map->{$infodb_value_key}})
|
---|
| 343 | {
|
---|
| 344 | $infodb_entry_value .= "<$infodb_value_key>" . $infodb_value . "\n";
|
---|
| 345 | }
|
---|
| 346 | }
|
---|
| 347 |
|
---|
| 348 | return $infodb_entry_value;
|
---|
| 349 | }
|
---|
| 350 |
|
---|
| 351 |
|
---|
| 352 | sub convert_infodb_string_to_hash
|
---|
| 353 | {
|
---|
| 354 | my $infodb_entry_value = shift(@_);
|
---|
| 355 | my $infodb_map = ();
|
---|
[22121] | 356 |
|
---|
| 357 | if (!defined $infodb_entry_value) {
|
---|
| 358 | print STDERR "Warning: No value to convert into a infodb hashtable\n";
|
---|
| 359 | }
|
---|
| 360 | else {
|
---|
| 361 | while ($infodb_entry_value =~ /^<(.*?)>(.*)$/mg)
|
---|
| 362 | {
|
---|
| 363 | my $infodb_value_key = $1;
|
---|
| 364 | my $infodb_value = $2;
|
---|
[21550] | 365 |
|
---|
[22121] | 366 | if (!defined($infodb_map->{$infodb_value_key}))
|
---|
| 367 | {
|
---|
| 368 | $infodb_map->{$infodb_value_key} = [ $infodb_value ];
|
---|
| 369 | }
|
---|
| 370 | else
|
---|
| 371 | {
|
---|
| 372 | push(@{$infodb_map->{$infodb_value_key}}, $infodb_value);
|
---|
| 373 | }
|
---|
| 374 | }
|
---|
[21550] | 375 | }
|
---|
| 376 |
|
---|
| 377 | return $infodb_map;
|
---|
| 378 | }
|
---|
| 379 |
|
---|
| 380 |
|
---|
[15699] | 381 | 1;
|
---|