Open-ILS/src/perlmods/OpenILS/Utils/CStoreEditor.pm

   1 use strict; use warnings;
   2 package OpenILS::Utils::CStoreEditor;
   3 use OpenILS::Application::AppUtils;
   4 use OpenSRF::AppSession;
   5 use OpenSRF::EX qw(:try);
   6 use OpenILS::Utils::Fieldmapper;
   7 use OpenILS::Event;
   8 use Data::Dumper;
   9 use JSON;
  10 use OpenSRF::Utils::Logger qw($logger);
  11 my $U = "OpenILS::Application::AppUtils";
  12 my %PERMS;
  13
  14
  15 # -----------------------------------------------------------------------------
  16 # Export some useful functions
  17 # -----------------------------------------------------------------------------
  18 use vars qw(@EXPORT_OK %EXPORT_TAGS);
  19 use Exporter;
  20 use base qw/Exporter/;
  21 push @EXPORT_OK, 'new_editor';
  22 %EXPORT_TAGS = ( funcs => [ qw/ new_editor / ] );
  23
  24 sub new_editor { return OpenILS::Utils::CStoreEditor->new(@_); }
  25
  26
  27 # -----------------------------------------------------------------------------
  28 # Log levels
  29 # -----------------------------------------------------------------------------
  30 use constant E => 'error';
  31 use constant W => 'warn';
  32 use constant I => 'info';
  33 use constant D => 'debug';
  34 use constant A => 'activity';
  35
  36
  37
  38 # -----------------------------------------------------------------------------
  39 # Params include:
  40 #       xact=><true> : creates a storage transaction
  41 #       authtoken=>$token : the login session key
  42 # -----------------------------------------------------------------------------
  43 sub new {
  44         my( $class, %params ) = @_;
  45         $class = ref($class) || $class;
  46         my $self = bless( \%params, $class );
  47         $self->{checked_perms} = {};
  48         return $self;
  49 }
  50
  51 # -----------------------------------------------------------------------------
  52 # Log the editor metadata along with the log string
  53 # -----------------------------------------------------------------------------
  54 sub log {
  55         my( $self, $lev, $str ) = @_;
  56         my $s = "editor[";
  57         $s .= "0|" unless $self->{xact};
  58         $s .= "1|" if $self->{xact};
  59         $s .= "0" unless $self->requestor;
  60         $s .= $self->requestor->id if $self->requestor;
  61         $s .= "]";
  62         $logger->$lev("$s $str");
  63 }
  64
  65 # -----------------------------------------------------------------------------
  66 # Verifies the auth token and fetches the requestor object
  67 # -----------------------------------------------------------------------------
  68 sub checkauth {
  69         my $self = shift;
  70         $self->log(D, "checking auth token ".$self->authtoken);
  71         my ($reqr, $evt) = $U->checkses($self->authtoken);
  72         $self->event($evt) if $evt;
  73         return $self->{requestor} = $reqr;
  74 }
  75
  76
  77 # -----------------------------------------------------------------------------
  78 # Returns the last generated event
  79 # -----------------------------------------------------------------------------
  80 sub event {
  81         my( $self, $evt ) = @_;
  82         $self->{event} = $evt if $evt;
  83         return $self->{event};
  84 }
  85
  86 # -----------------------------------------------------------------------------
  87 # Clears the last caught event
  88 # -----------------------------------------------------------------------------
  89 sub clear_event {
  90         my $self = shift;
  91         $self->{event} = undef;
  92 }
  93
  94 sub authtoken {
  95         my( $self, $auth ) = @_;
  96         $self->{authtoken} = $auth if $auth;
  97         return $self->{authtoken};
  98 }
  99
 100 # -----------------------------------------------------------------------------
 101 # fetches the session, creating if necessary.  If 'xact' is true on this
 102 # object, a db session is created
 103 # -----------------------------------------------------------------------------
 104 sub session {
 105         my( $self, $session ) = @_;
 106         $self->{session} = $session if $session;
 107
 108         if(!$self->{session}) {
 109                 $self->{session} = OpenSRF::AppSession->create('open-ils.cstore');
 110
 111                 if( ! $self->{session} ) {
 112                         my $str = "Error creating cstore session with OpenSRF::AppSession->create()!";
 113                         $self->log(E, $str);
 114                         throw OpenSRF::EX::ERROR ($str);
 115                 }
 116
 117                 $self->{session}->connect if $self->{xact} or $self->{connect};
 118                 $self->xact_start if $self->{xact};
 119         }
 120         return $self->{session};
 121 }
 122
 123
 124 # -----------------------------------------------------------------------------
 125 # Starts a storage transaction
 126 # -----------------------------------------------------------------------------
 127 sub xact_start {
 128         my $self = shift;
 129         $self->log(D, "starting new db session");
 130         my $stat = $self->request('open-ils.cstore.transaction.begin');
 131         $self->log(E, "error starting database transaction") unless $stat;
 132         return $stat;
 133 }
 134
 135 # -----------------------------------------------------------------------------
 136 # Commits a storage transaction
 137 # -----------------------------------------------------------------------------
 138 sub xact_commit {
 139         my $self = shift;
 140         $self->log(D, "comitting db session");
 141         my $stat = $self->request('open-ils.cstore.transaction.commit');
 142         $self->log(E, "error comitting database transaction") unless $stat;
 143         return $stat;
 144 }
 145
 146 # -----------------------------------------------------------------------------
 147 # Rolls back a storage stransaction
 148 # -----------------------------------------------------------------------------
 149 sub xact_rollback {
 150         my $self = shift;
 151         $self->log(I, "rolling back db session");
 152         return $self->request("open-ils.cstore.transaction.rollback");
 153 }
 154
 155
 156 # -----------------------------------------------------------------------------
 157 # commits the db session and destroys the session
 158 # -----------------------------------------------------------------------------
 159 sub commit {
 160         my $self = shift;
 161         return unless $self->{xact};
 162         $self->xact_commit;
 163         $self->session->disconnect;
 164         $self->{session} = undef;
 165 }
 166
 167 # -----------------------------------------------------------------------------
 168 # clears all object data. Does not commit the db transaction.
 169 # -----------------------------------------------------------------------------
 170 sub reset {
 171         my $self = shift;
 172         $self->session->disconnect if $self->{session};
 173         $$self{$_} = undef for (keys %$self);
 174 }
 175
 176
 177 # -----------------------------------------------------------------------------
 178 # commits and resets
 179 # -----------------------------------------------------------------------------
 180 sub finish {
 181         my $self = shift;
 182         $self->commit;
 183         $self->reset;
 184 }
 185
 186
 187
 188 # -----------------------------------------------------------------------------
 189 # Does a simple storage request
 190 # -----------------------------------------------------------------------------
 191 sub request {
 192         my( $self, $method, @params ) = @_;
 193
 194         my $val;
 195         my $err;
 196         my $argstr = __arg_to_string( (scalar(@params)) == 1 ? $params[0] : \@params);
 197
 198         $self->log(I, "request $method : $argstr");
 199
 200         try {
 201                 $val = $self->session->request($method, @params)->gather(1);
 202
 203         } catch Error with {
 204                 $err = shift;
 205                 $self->log(E, "request error $method : $argstr : $err");
 206         };
 207
 208         throw $err if $err;
 209         return $val;
 210 }
 211
 212
 213 # -----------------------------------------------------------------------------
 214 # Sets / Returns the requstor object.  This is set when checkauth succeeds.
 215 # -----------------------------------------------------------------------------
 216 sub requestor {
 217         my($self, $requestor) = @_;
 218         $self->{requestor} = $requestor if $requestor;
 219         return $self->{requestor};
 220 }
 221
 222
 223
 224 # -----------------------------------------------------------------------------
 225 # Holds the last data received from a storage call
 226 # -----------------------------------------------------------------------------
 227 sub data {
 228         my( $self, $data ) = @_;
 229         $self->{data} = $data if defined $data;
 230         return $self->{data};
 231 }
 232
 233
 234 # -----------------------------------------------------------------------------
 235 # True if this perm has already been checked at this org
 236 # -----------------------------------------------------------------------------
 237 sub perm_checked {
 238         my( $self, $perm, $org ) = @_;
 239         $self->{checked_perms}->{$org} = {}
 240                 unless $self->{checked_perms}->{$org};
 241         my $checked = $self->{checked_perms}->{$org}->{$perm};
 242         if(!$checked) {
 243                 $self->{checked_perms}->{$org}->{$perm} = 1;
 244                 return 0;
 245         }
 246         return 1;
 247 }
 248
 249
 250
 251 # -----------------------------------------------------------------------------
 252 # Returns true if the requested perm is allowed.  If the perm check fails,
 253 # $e->event is set and undef is returned
 254 # The perm user is $e->requestor->id and perm org defaults to the requestor's
 255 # ws_ou
 256 # If this perm at the given org has already been verified, true is returned
 257 # and the perm is not re-checked
 258 # -----------------------------------------------------------------------------
 259 sub allowed {
 260         my( $self, $perm, $org ) = @_;
 261         my $uid = $self->requestor->id;
 262         $org ||= $self->requestor->ws_ou;
 263         $self->log(I, "checking perms user=$uid, org=$org, perm=$perm");
 264         return 1 if $self->perm_checked($perm, $org);
 265         return $self->checkperm($uid, $org, $perm);
 266 }
 267
 268 sub checkperm {
 269         my($self, $userid, $org, $perm) = @_;
 270         my $s = $U->storagereq(
 271                 "open-ils.storage.permission.user_has_perm", $userid, $perm, $org );
 272
 273         if(!$s) {
 274                 my $e = OpenILS::Event->new('PERM_FAILURE', ilsperm => $perm, ilspermloc => $org);
 275                 $self->event($e);
 276                 return undef;
 277         }
 278
 279         return 1;
 280 }
 281
 282
 283
 284 # -----------------------------------------------------------------------------
 285 # checks the appropriate perm for the operation
 286 # -----------------------------------------------------------------------------
 287 sub _checkperm {
 288         my( $self, $ptype, $action, $org ) = @_;
 289         $org ||= $self->requestor->ws_ou;
 290         my $perm = $PERMS{$ptype}{$action};
 291         if( $perm ) {
 292                 return undef if $self->perm_checked($perm, $org);
 293                 return $self->event unless $self->allowed($perm, $org);
 294         } else {
 295                 $self->log(E, "no perm provided for $ptype.$action");
 296         }
 297         return undef;
 298 }
 299
 300
 301
 302 # -----------------------------------------------------------------------------
 303 # Logs update actions to the activity log
 304 # -----------------------------------------------------------------------------
 305 sub log_activity {
 306         my( $self, $type, $action, $arg ) = @_;
 307         my $str = "$type.$action";
 308         $str .= _prop_string($arg);
 309         $self->log(A, $str);
 310 }
 311
 312
 313
 314 sub _prop_string {
 315         my $obj = shift;
 316         my @props = $obj->properties;
 317         my $str = "";
 318         for(@props) {
 319                 my $prop = $obj->$_() || "";
 320                 $prop = substr($prop, 0, 128) . "..." if length $prop > 131;
 321                 $str .= " $_=$prop";
 322         }
 323         return $str;
 324 }
 325
 326
 327 sub __arg_to_string {
 328         my $arg = shift;
 329         return "" unless defined $arg;
 330         if( UNIVERSAL::isa($arg, "Fieldmapper") ) {
 331                 return (defined $arg->id) ? $arg->id : '<new object>';
 332         }
 333         return JSON->perl2JSON($arg);
 334         return "";
 335 }
 336
 337
 338 # -----------------------------------------------------------------------------
 339 # This does the actual storage query.
 340 #
 341 # 'search' calls become search_where calls and $arg can be a search hash or
 342 # an array-ref of storage search options.
 343 #
 344 # 'retrieve' expects an id
 345 # 'update' expects an object
 346 # 'create' expects an object
 347 # 'delete' expects an object
 348 #
 349 # All methods return true on success and undef on failure.  On failure,
 350 # $e->event is set to the generated event.
 351 # Note: this method assumes that updating a non-changed object and
 352 # thereby receiving a 0 from storage, is a successful update.
 353 #
 354 # The method will therefore return true so the caller can just do
 355 # $e->update_blah($x) or return $e->event;
 356 # The true value returned from storage for all methods will be stored in
 357 # $e->data, until the next method is called.
 358 #
 359 # not-found events are generated on retrieve and serach methods.
 360 # action=search methods will return [] (==true) if no data is found.  If the
 361 # caller is interested in the not found event, they can do:
 362 # return $e->event unless @$results;
 363 # -----------------------------------------------------------------------------
 364 sub runmethod {
 365         my( $self, $action, $type, $arg, $options ) = @_;
 366
 367         my @arg = ( ref($arg) eq 'ARRAY' ) ? @$arg : ($arg);
 368         my $method = "open-ils.cstore.direct.$type.$action";
 369
 370         if( $action eq 'search' ) {
 371                 $method = "$method.atomic";
 372
 373         } elsif( $action eq 'batch_retrieve' ) {
 374                 $action = 'search';
 375                 @arg = ( { id => $arg } );
 376                 $method =~ s/batch_retrieve/search/o;
 377                 $method = "$method.atomic";
 378
 379         } elsif( $action eq 'retrieve_all' ) {
 380                 $action = 'search';
 381                 $method =~ s/retrieve_all/search/o;
 382                 my $tt = $type;
 383                 $tt =~ s/\./::/og;
 384                 my $fmobj = "Fieldmapper::$tt";
 385                 @arg = ( { $fmobj->Identity => { '!=' => undef } } );
 386                 $method = "$method.atomic";
 387         }
 388
 389         $method =~ s/search/id_list/o if $options->{idlist};
 390
 391         # remove any stale events
 392         $self->clear_event;
 393
 394         if( $action eq 'update' or $action eq 'delete' or $action eq 'create' ) {
 395                 if(!$self->{xact}) {
 396                         $logger->error("Attempt to update DB while not in a transaction : $method");
 397                         throw OpenSRF::EX::ERROR ("Attempt to update DB while not in a transaction : $method");
 398                 }
 399                 $self->log_activity($type, $action, $arg);
 400         }
 401
 402         if($$options{checkperm}) {
 403                 my $a = ($action eq 'search') ? 'retrieve' : $action;
 404                 my $e = $self->_checkperm($type, $a, $$options{permorg});
 405                 if($e) {
 406                         $self->event($e);
 407                         return undef;
 408                 }
 409         }
 410
 411         my $obj;
 412         my $err;
 413
 414         try {
 415                 $obj = $self->request($method, @arg);
 416         } catch Error with { $err = shift; };
 417
 418
 419         if(!defined $obj) {
 420                 $self->log(I, "request returned no data : $method");
 421
 422                 if( $action eq 'retrieve' ) {
 423                         $self->event(_mk_not_found($type, $arg));
 424
 425                 } elsif( $action eq 'update' or
 426                                 $action eq 'delete' or $action eq 'create' ) {
 427                         my $evt = OpenILS::Event->new(
 428                                 'DATABASE_UPDATE_FAILED', payload => $arg, debug => "$err" );
 429                         $self->event($evt);
 430                 }
 431
 432                 if( $err ) {
 433                         $self->event(
 434                                 OpenILS::Event->new( 'DATABASE_QUERY_FAILED',
 435                                         payload => $arg, debug => "$err" ));
 436                         return undef;
 437                 }
 438
 439                 return undef;
 440         }
 441
 442         if( $action eq 'create' and $obj == 0 ) {
 443                 my $evt = OpenILS::Event->new(
 444                         'DATABASE_UPDATE_FAILED', payload => $arg, debug => "$err" );
 445                 $self->event($evt);
 446                 return undef;
 447         }
 448
 449         # If we havn't dealt with the error in a nice way, go ahead and throw it
 450         if( $err ) {
 451                 $self->event(
 452                         OpenILS::Event->new( 'DATABASE_QUERY_FAILED',
 453                                 payload => $arg, debug => "$err" ));
 454                 return undef;
 455         }
 456
 457         if( $action eq 'search' or $action eq 'batch_retrieve' or $action eq 'retrieve_all') {
 458                 $self->log(I, "$type.$action : returned ".scalar(@$obj). " result(s)");
 459                 $self->event(_mk_not_found($type, $arg)) unless @$obj;
 460         }
 461
 462         $arg->id($obj->id) if $action eq 'create'; # grabs the id on create
 463         $self->data($obj); # cache the data for convenience
 464
 465         return ($obj) ? $obj : 1;
 466 }
 467
 468
 469 sub _mk_not_found {
 470         my( $type, $arg ) = @_;
 471         (my $t = $type) =~ s/\./_/og;
 472         $t = uc($t);
 473         return OpenILS::Event->new("${t}_NOT_FOUND", payload => $arg);
 474 }
 475
 476
 477
 478 # utility method for loading
 479 sub __fm2meth {
 480         my $str = shift;
 481         my $sep = shift;
 482         $str =~ s/Fieldmapper:://o;
 483         $str =~ s/::/$sep/g;
 484         return $str;
 485 }
 486
 487
 488 # -------------------------------------------------------------
 489 # Load up the methods from the FM classes
 490 # -------------------------------------------------------------
 491 my $map = $Fieldmapper::fieldmap;
 492 for my $object (keys %$map) {
 493         my $obj = __fm2meth($object,'_');
 494         my $type = __fm2meth($object, '.');
 495
 496         my $update = "update_$obj";
 497         my $updatef =
 498                 "sub $update {return shift()->runmethod('update', '$type', \@_);}";
 499         eval $updatef;
 500
 501         my $retrieve = "retrieve_$obj";
 502         my $retrievef =
 503                 "sub $retrieve {return shift()->runmethod('retrieve', '$type', \@_);}";
 504         eval $retrievef;
 505
 506         my $search = "search_$obj";
 507         my $searchf =
 508                 "sub $search {return shift()->runmethod('search', '$type', \@_);}";
 509         eval $searchf;
 510
 511         my $create = "create_$obj";
 512         my $createf =
 513                 "sub $create {return shift()->runmethod('create', '$type', \@_);}";
 514         eval $createf;
 515
 516         my $delete = "delete_$obj";
 517         my $deletef =
 518                 "sub $delete {return shift()->runmethod('delete', '$type', \@_);}";
 519         eval $deletef;
 520
 521         my $bretrieve = "batch_retrieve_$obj";
 522         my $bretrievef =
 523                 "sub $bretrieve {return shift()->runmethod('batch_retrieve', '$type', \@_);}";
 524         eval $bretrievef;
 525
 526         my $retrieveall = "retrieve_all_$obj";
 527         my $retrieveallf =
 528                 "sub $retrieveall {return shift()->runmethod('retrieve_all', '$type', \@_);}";
 529         eval $retrieveallf;
 530 }
 531
 532
 533
 534 1;
 535
 536