Open-ILS/src/perlmods/OpenILS/Application/Storage/CDBI.pm

   1 package OpenILS::Application::Storage::CDBI;
   2 use base qw/Class::DBI/;
   3 use Class::DBI;
   4 use Class::DBI::AbstractSearch;
   5
   6 use OpenILS::Application::Storage::CDBI::actor;
   7 use OpenILS::Application::Storage::CDBI::action;
   8 use OpenILS::Application::Storage::CDBI::asset;
   9 use OpenILS::Application::Storage::CDBI::authority;
  10 use OpenILS::Application::Storage::CDBI::biblio;
  11 use OpenILS::Application::Storage::CDBI::config;
  12 use OpenILS::Application::Storage::CDBI::metabib;
  13 use OpenILS::Application::Storage::CDBI::money;
  14 use OpenILS::Application::Storage::CDBI::permission;
  15
  16 use OpenSRF::Utils::Logger;
  17 use OpenSRF::EX qw/:try/;
  18
  19 our $VERSION = undef;
  20 my $log = 'OpenSRF::Utils::Logger';
  21
  22 sub child_init {
  23         my $self = shift;
  24
  25         $log->debug("Creating ImaDBI Querys", DEBUG);
  26         __PACKAGE__->set_sql( 'OILSFastSearch', <<"     SQL", 'Main');
  27                 SELECT  %s
  28                   FROM  %s
  29                   WHERE %s = ?
  30         SQL
  31
  32         __PACKAGE__->set_sql( 'OILSFastOrderedSearchLike', <<"  SQL", 'Main');
  33                 SELECT  %s
  34                   FROM  %s
  35                   WHERE %s LIKE ?
  36                   ORDER BY %s
  37         SQL
  38
  39         __PACKAGE__->set_sql( 'OILSFastOrderedSearch', <<"      SQL", 'Main');
  40                 SELECT  %s
  41                   FROM  %s
  42                   WHERE %s = ?
  43                   ORDER BY %s
  44         SQL
  45
  46         $log->debug("Calling Driver child_init", DEBUG);
  47         $self->SUPER::child_init(@_);
  48
  49 }
  50
  51 sub fast_flesh_sth {
  52         my $class = shift;
  53         $class = ref($class) || $class;
  54
  55         my $field = shift;
  56         my $value = shift;
  57         my $order = shift;
  58         my $like = shift;
  59
  60
  61         if (!(defined($order) and ref($order) and ref($order) eq 'HASH')) {
  62                 if (defined($value) and ref($value) and ref($value) eq 'HASH') {
  63                         $order = $value;
  64                         $value = undef;
  65                 } else {
  66                         $order = { order_by => $class->columns('Primary') }
  67                 }
  68         }
  69
  70         unless (defined $value) {
  71                 $value = $field;
  72                 ($field) = $class->columns('Primary');
  73         }
  74
  75         unless (defined $field) {
  76                 ($field) = $class->columns('Primary');
  77         }
  78
  79         unless ($order->{order_by}) {
  80                 $order = { order_by => $class->columns('Primary') }
  81         }
  82
  83         my $fm_class = 'Fieldmapper::'.$class;
  84         my $field_list = join ',', $class->columns('All');
  85
  86         my $sth;
  87         if (!$like) {
  88                 $sth = $class->sql_OILSFastOrderedSearch( $field_list, $class->table, $field, $order->{order_by});
  89         } else {
  90                 $sth = $class->sql_OILSFastOrderedSearchLike( $field_list, $class->table, $field, $order->{order_by});
  91         }
  92         $sth->execute($value);
  93         return $sth;
  94 }
  95
  96 sub fast_flesh {
  97         my $self = shift;
  98         return map $class->construct($_), $self->fast_flesh_sth(@_)->fetchall_hash;
  99 }
 100
 101 sub fast_fieldmapper {
 102         my $self = shift;
 103         my $id = shift;
 104         my $col = shift;
 105         my $like = shift;
 106         my $options = shift;
 107         my $class = ref($self) || $self;
 108         my $fm_class = 'Fieldmapper::'.$class;
 109         my @fms;
 110         $log->debug("fast_fieldmapper() ==> Retrieving $fm_class", INTERNAL);
 111         if ($like < 2) {
 112                 for my $hash ($self->fast_flesh_sth( $col, "$id", { order_by => $col }, $like )->fetchall_hash) {
 113                         my $fm = $fm_class->new;
 114                         for my $field ( $fm_class->real_fields ) {
 115                                 $fm->$field( $$hash{$field} );
 116                         }
 117                         push @fms, $fm;
 118                 }
 119         } else {
 120                 my $search_type = 'search';
 121                 if ($like == 2) {
 122                         $search_type = 'search_fts'
 123                 } elsif ($like == 3) {
 124                         $search_type = 'search_regex'
 125                 }
 126
 127                 for my $obj ($class->$search_type({ $col => $id}, $options)) {
 128                         push @fms, $obj->to_fieldmapper;
 129                 }
 130         }
 131         return @fms;
 132 }
 133
 134 sub retrieve {
 135         my $self = shift;
 136         my $arg = shift;
 137         if (ref($arg) and UNIVERSAL::isa($arg => 'Fieldmapper')) {
 138                 my ($col) = $self->primary_column;
 139                 $log->debug("Using field $col as the primary key", INTERNAL);
 140                 $arg = $arg->$col;
 141         }
 142         $log->debug("Retrieving $self with $arg", INTERNAL);
 143         my $rec;
 144         try {
 145                 $rec = $self->SUPER::retrieve("$arg");
 146         } catch Error with {
 147                 $log->debug("Could not retrieve $self with $arg! -- ".shift(), DEBUG);
 148                 return undef;
 149         };
 150         return $rec;
 151 }
 152
 153 sub to_fieldmapper {
 154         my $obj = shift;
 155         my $class = ref($obj) || $obj;
 156
 157         my $fm_class = 'Fieldmapper::'.$class;
 158         my $fm = $fm_class->new;
 159
 160         if (ref($obj)) {
 161                 for my $field ( $fm->real_fields ) {
 162                         $fm->$field( $obj->$field );
 163                 }
 164         }
 165
 166         return $fm;
 167 }
 168
 169 sub merge {
 170         my $self = shift;
 171         my $search = shift;
 172         my $arg = shift;
 173
 174         delete $$arg{$_} for (keys %$search);
 175
 176         my @objs = ($self);
 177         @objs = $self->search_where($search) unless (ref $self);
 178
 179         if (@objs == 1) {
 180                 return $objs[0]->update($arg);
 181         } elsif (@objs == 0) {
 182                 return $self->create({%$search,%$arg});
 183         } else {
 184                 throw OpenSRF::EX::WARN ("Non-unique search key for merge.  Perhaps you meant to use remote_update?");
 185         }
 186 }
 187
 188 sub remote_update {
 189         my $self = shift;
 190         my $search = shift;
 191         my $arg = shift;
 192
 193         delete $$arg{$_} for (keys %$search);
 194
 195         my @objs = $self->search_where($search);
 196         if (@objs == 0) {
 197                 throw OpenSRF::EX::WARN ("No objects found for remote_update.  Perhaps you meant to use merge?");
 198         } else {
 199                 $_->update($arg) for (@objs);
 200                 return scalar(@objs);
 201         }
 202 }
 203
 204 sub create {
 205         my $self = shift;
 206         my $arg = shift;
 207
 208         $log->debug("\$arg is $arg (".ref($arg).")",DEBUG);
 209
 210         if (ref($arg) && UNIVERSAL::isa($arg => 'Fieldmapper')) {
 211                 return $self->create_from_fieldmapper($arg,@_);
 212         }
 213
 214         return $self->SUPER::create($arg,@_);
 215 }
 216
 217 sub create_from_fieldmapper {
 218         my $obj = shift;
 219         my $fm = shift;
 220         my @params = @_;
 221
 222         $log->debug("Creating node of type ".ref($fm), DEBUG);
 223
 224         my $class = ref($obj) || $obj;
 225         my ($primary) = $class->columns('Primary');
 226
 227         if (ref($fm) &&UNIVERSAL::isa($fm => 'Fieldmapper')) {
 228                 my %hash = map { defined $fm->$_ ?
 229                                         ($_ => $fm->$_) :
 230                                         ()
 231                                 } grep { $_ ne $primary } $class->columns('All');
 232
 233                 if ($class->find_column( 'last_xact_id' )) {
 234                         my $xact_id = $class->current_xact_id;
 235                         throw Error unless ($xact_id);
 236                         $hash{last_xact_id} = $xact_id;
 237                 }
 238
 239                 return $class->create( \%hash, @params );
 240         } else {
 241                 return undef;
 242         }
 243 }
 244
 245 sub delete {
 246         my $self = shift;
 247         my $arg = shift;
 248
 249         my $class = ref($self) || $self;
 250
 251         if (ref($arg) and UNIVERSAL::isa($arg => 'Fieldmapper')) {
 252                 $self = $self->retrieve($arg);
 253                 unless (defined $self) {
 254                         $log->debug("ARG! Couldn't retrieve record ".$arg->id, DEBUG);
 255                         throw OpenSRF::EX::WARN ("ARG! Couldn't retrieve record ");
 256                 }
 257         }
 258
 259         if ($class->find_column( 'last_xact_id' )) {
 260                 my $xact_id = $self->current_xact_id;
 261                 throw Error unless ($xact_id);
 262                 $self->last_xact_id( $class->current_xact_id );
 263                 $self->SUPER::update;
 264         }
 265
 266         $self->SUPER::delete;
 267         return 1;
 268 }
 269
 270 sub update {
 271         my $self = shift;
 272         my $arg = shift;
 273
 274         $log->debug("Attempting to update using $arg", DEBUG) if ($arg);
 275
 276         if (ref($arg)) {
 277                 $self = $self->modify_from_fieldmapper($arg);
 278                 $log->debug("Modification of $self seems to have failed....", DEBUG);
 279                 return undef unless (defined $self);
 280         }
 281
 282         $log->debug("Calling Class::DBI->update on modified object $self", DEBUG);
 283         return $self->SUPER::update if ($self->is_changed);
 284         return 0;
 285 }
 286
 287 sub modify_from_fieldmapper {
 288         my $obj = shift;
 289         my $fm = shift;
 290
 291         $log->debug("Modifying object using fieldmapper", DEBUG);
 292
 293         my $class = ref($obj) || $obj;
 294         my ($primary) = $class->columns('Primary');
 295
 296         if (!ref($obj)) {
 297                 $obj = $class->retrieve($fm);
 298                 unless ($obj) {
 299                         $log->debug("Retrieve of $class using $fm (".$fm->id.") failed! -- ".shift(), ERROR);
 300                         throw OpenSRF::EX::WARN ("No $class with id of ".$fm->id."!!");
 301                 }
 302         }
 303
 304         my %hash;
 305
 306         if (ref($fm) and UNIVERSAL::isa($fm => 'Fieldmapper')) {
 307                 %hash = map { defined $fm->$_ ?
 308                                 ($_ => ''.$fm->$_) :
 309                                 ()
 310                         } grep { $_ ne $primary } $class->columns('All');
 311         } else {
 312                 %hash = %{$fm};
 313         }
 314
 315         my $au = $obj->autoupdate;
 316         $obj->autoupdate(0);
 317
 318         for my $field ( keys %hash ) {
 319                 $obj->$field( $hash{$field} ) if ($obj->$field ne $hash{$field});
 320                 $log->debug("Setting field $field on $obj to $hash{$field}",INTERNAL);
 321         }
 322
 323         if ($class->find_column( 'last_xact_id' ) and $obj->is_changed) {
 324                 my $xact_id = $obj->current_xact_id;
 325                 throw Error unless ($xact_id);
 326                 $obj->last_xact_id( $xact_id );
 327         } else {
 328                 $obj->autoupdate($au)
 329         }
 330
 331         return $obj;
 332 }
 333
 334
 335
 336         #-------------------------------------------------------------------------------
 337         actor::user->has_a( home_ou => 'actor::org_unit' );
 338         actor::user->has_a( card => 'actor::card' );
 339         actor::user->has_a( standing => 'config::standing' );
 340         actor::user->has_a( profile => 'actor::profile' );
 341         actor::user->has_a( mailing_address => 'actor::user_address' );
 342         actor::user->has_a( billing_address => 'actor::user_address' );
 343         actor::user->has_a( ident_type => 'config::identification_type' );
 344         actor::user->has_a( ident_type2 => 'config::identification_type' );
 345         actor::user->has_a( net_access_level => 'config::net_access_level' );
 346
 347         actor::user_address->has_a( usr => 'actor::user' );
 348
 349         actor::card->has_a( usr => 'actor::user' );
 350
 351         actor::org_unit->has_a( parent_ou => 'actor::org_unit' );
 352         actor::org_unit->has_a( ou_type => 'actor::org_unit_type' );
 353         #actor::org_unit->has_a( address => 'actor::org_address' );
 354
 355         actor::stat_cat_entry->has_a( stat_cat => 'actor::stat_cat' );
 356         actor::stat_cat->has_many( entries => 'actor::stat_cat_entry' );
 357         actor::stat_cat_entry_user_map->has_a( stat_cat => 'actor::stat_cat' );
 358         actor::stat_cat_entry_user_map->has_a( stat_cat_entry => 'actor::stat_cat_entry' );
 359         actor::stat_cat_entry_user_map->has_a( target_usr => 'actor::user' );
 360
 361         asset::stat_cat_entry->has_a( stat_cat => 'asset::stat_cat' );
 362         asset::stat_cat->has_many( entries => 'asset::stat_cat_entry' );
 363         asset::stat_cat_entry_copy_map->has_a( stat_cat => 'asset::stat_cat' );
 364         asset::stat_cat_entry_copy_map->has_a( stat_cat_entry => 'asset::stat_cat_entry' );
 365         asset::stat_cat_entry_copy_map->has_a( owning_copy => 'asset::copy' );
 366
 367         action::survey_response->has_a( usr => 'actor::user' );
 368         action::survey_response->has_a( survey => 'action::survey' );
 369         action::survey_response->has_a( question => 'action::survey_question' );
 370         action::survey_response->has_a( answer => 'action::survey_answer' );
 371
 372         action::survey_question->has_a( survey => 'action::survey' );
 373
 374         action::survey_answer->has_a( question => 'action::survey' );
 375
 376         asset::copy_note->has_a( owning_copy => 'asset::copy' );
 377
 378         actor::user->has_many( stat_cat_entries => [ 'actor::stat_cat_entry_user_map' => 'stat_cat_entry' ] );
 379         actor::user->has_many( stat_cat_entry_user_maps => 'actor::stat_cat_entry_user_map' );
 380
 381         asset::copy->has_many( stat_cat_entries => [ 'asset::stat_cat_entry_copy_map' => 'stat_cat_entry' ] );
 382         asset::copy->has_many( stat_cat_entry_copy_maps => 'asset::stat_cat_entry_copy_map' );
 383
 384         asset::copy->has_a( call_number => 'asset::call_number' );
 385         asset::copy->has_a( creator => 'actor::user' );
 386         asset::copy->has_a( editor => 'actor::user' );
 387         asset::copy->has_a( status => 'config::copy_status' );
 388         asset::copy->has_a( location => 'asset::copy_location' );
 389         asset::copy->has_a( circ_lib => 'actor::org_unit' );
 390
 391         asset::call_number_note->has_a( call_number => 'asset::call_number' );
 392
 393         asset::call_number->has_a( record => 'biblio::record_entry' );
 394         asset::call_number->has_a( creator => 'actor::user' );
 395         asset::call_number->has_a( editor => 'actor::user' );
 396
 397         authority::record_note->has_a( record => 'authority::record_entry' );
 398         biblio::record_note->has_a( record => 'biblio::record_entry' );
 399
 400         authority::record_entry->has_a( creator => 'actor::user' );
 401         authority::record_entry->has_a( editor => 'actor::user' );
 402         biblio::record_entry->has_a( creator => 'actor::user' );
 403         biblio::record_entry->has_a( editor => 'actor::user' );
 404
 405         metabib::metarecord->has_a( master_record => 'biblio::record_entry' );
 406
 407         authority::record_descriptor->has_a( record => 'authority::record_entry' );
 408         metabib::record_descriptor->has_a( record => 'biblio::record_entry' );
 409
 410         authority::full_rec->has_a( record => 'authority::record_entry' );
 411         metabib::full_rec->has_a( record => 'biblio::record_entry' );
 412
 413         metabib::title_field_entry->has_a( source => 'biblio::record_entry' );
 414         metabib::title_field_entry->has_a( field => 'config::metabib_field' );
 415
 416         metabib::author_field_entry->has_a( source => 'biblio::record_entry' );
 417         metabib::author_field_entry->has_a( field => 'config::metabib_field' );
 418
 419         metabib::subject_field_entry->has_a( source => 'biblio::record_entry' );
 420         metabib::subject_field_entry->has_a( field => 'config::metabib_field' );
 421
 422         metabib::keyword_field_entry->has_a( source => 'biblio::record_entry' );
 423         metabib::keyword_field_entry->has_a( field => 'config::metabib_field' );
 424
 425         metabib::series_field_entry->has_a( source => 'biblio::record_entry' );
 426         metabib::series_field_entry->has_a( field => 'config::metabib_field' );
 427
 428         metabib::metarecord_source_map->has_a( metarecord => 'metabib::metarecord' );
 429         metabib::metarecord_source_map->has_a( source => 'biblio::record_entry' );
 430
 431         action::circulation->has_a( usr => 'actor::user' );
 432         action::circulation->has_a( target_copy => 'asset::copy' );
 433         action::circulation->has_a( circ_lib => 'actor::org_unit' );
 434
 435         money::billable_transaction->has_a( usr => 'actor::user' );
 436
 437
 438         #-------------------------------------------------------------------------------
 439         actor::user->has_many( survey_responses => 'action::survey_response' );
 440         actor::user->has_many( addresses => 'actor::user_address' );
 441         actor::user->has_many( cards => 'actor::card' );
 442
 443         actor::org_unit->has_many( users => 'actor::user' );
 444         actor::profile->has_many( users => 'actor::user' );
 445
 446         action::survey->has_many( questions => 'action::survey_question' );
 447         action::survey->has_many( responses => 'action::survey_response' );
 448
 449         action::survey_question->has_many( answers => 'action::survey_answer' );
 450         action::survey_question->has_many( responses => 'action::survey_response' );
 451
 452         action::survey_answer->has_many( responses => 'action::survey_response' );
 453
 454         asset::copy->has_many( notes => 'asset::copy_note' );
 455         asset::call_number->has_many( copies => 'asset::copy' );
 456         asset::call_number->has_many( notes => 'asset::call_number_note' );
 457
 458         authority::record_entry->has_many( record_descriptor => 'authority::record_descriptor' );
 459         authority::record_entry->has_many( notes => 'authority::record_note' );
 460
 461         biblio::record_entry->has_many( record_descriptor => 'metabib::record_descriptor' );
 462         biblio::record_entry->has_many( notes => 'biblio::record_note' );
 463         biblio::record_entry->has_many( call_numbers => 'asset::call_number' );
 464         biblio::record_entry->has_many( full_record_entries => 'metabib::full_rec' );
 465         biblio::record_entry->has_many( title_field_entries => 'metabib::title_field_entry' );
 466         biblio::record_entry->has_many( author_field_entries => 'metabib::author_field_entry' );
 467         biblio::record_entry->has_many( subject_field_entries => 'metabib::subject_field_entry' );
 468         biblio::record_entry->has_many( keyword_field_entries => 'metabib::keyword_field_entry' );
 469         biblio::record_entry->has_many( series_field_entries => 'metabib::series_field_entry' );
 470
 471         metabib::metarecord->has_many( source_records => [ 'metabib::metarecord_source_map' => 'source'] );
 472
 473         money::billable_transaction->has_many( billings => 'money::billing' );
 474         money::billable_transaction->has_many( payments => 'money::payment' );
 475
 476         money::billing->has_a( xact => 'money::billable_transaction' );
 477         money::payment->has_a( xact => 'money::billable_transaction' );
 478
 479         money::cash_payment->has_a( xact => 'money::billable_transaction' );
 480         money::cash_payment->has_a( accepting_usr => 'actor::user' );
 481
 482         money::check_payment->has_a( xact => 'money::billable_transaction' );
 483         money::check_payment->has_a( accepting_usr => 'actor::user' );
 484
 485         money::credit_card_payment->has_a( xact => 'money::billable_transaction' );
 486         money::credit_card_payment->has_a( accepting_usr => 'actor::user' );
 487
 488         money::forgive_payment->has_a( xact => 'money::billable_transaction' );
 489         money::forgive_payment->has_a( accepting_usr => 'actor::user' );
 490
 491         money::work_payment->has_a( xact => 'money::billable_transaction' );
 492         money::work_payment->has_a( accepting_usr => 'actor::user' );
 493
 494         money::credit_payment->has_a( xact => 'money::billable_transaction' );
 495         money::credit_payment->has_a( accepting_usr => 'actor::user' );
 496
 497         permission::grp_tree->has_a( parent => 'permission::grp_tree' );
 498
 499         permission::grp_perm_map->has_a( grp => 'permission::grp_tree' );
 500         permission::grp_perm_map->has_a(  perm => 'permission::perm_list' );
 501         permission::grp_perm_map->has_a(  depth => 'actor::org_unit_type' );
 502
 503         permission::usr_perm_map->has_a( usr => 'actor::user' );
 504         permission::usr_perm_map->has_a(  perm => 'permission::perm_list' );
 505         permission::usr_perm_map->has_a(  depth => 'actor::org_unit_type' );
 506
 507         permission::usr_grp_map->has_a(  usr => 'actor::user' );
 508         permission::usr_grp_map->has_a(  grp => 'permission::grp_tree' );
 509
 510         action::hold_notification->has_a(  hold => 'action::hold_request' );
 511
 512         action::hold_copy_map->has_a(  hold => 'action::hold_request' );
 513         action::hold_copy_map->has_a(  target_copy => 'asset::copy' );
 514
 515         action::hold_request->has_a(  current_copy => 'asset::copy' );
 516         action::hold_request->has_a(  requestor => 'actor::user' );
 517         action::hold_request->has_a(  usr => 'actor::user' );
 518         action::hold_request->has_a(  pickup_lib => 'actor::org_unit' );
 519
 520         action::hold_request->has_many(  notifications => 'action::hold_notification' );
 521         action::hold_request->has_many(  copy_maps => 'action::hold_copy_map' );
 522
 523         asset::copy->has_many(  hold_maps => 'action::hold_copy_map' );
 524
 525 1;