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