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;
10 use OpenSRF::Utils::Logger qw($logger);
11 my $U = "OpenILS::Application::AppUtils";
15 # -----------------------------------------------------------------------------
16 # Export some useful functions
17 # -----------------------------------------------------------------------------
18 use vars qw(@EXPORT_OK %EXPORT_TAGS);
20 use base qw/Exporter/;
21 push @EXPORT_OK, 'new_editor';
22 %EXPORT_TAGS = ( funcs => [ qw/ new_editor / ] );
24 sub new_editor { return OpenILS::Utils::CStoreEditor->new(@_); }
27 # -----------------------------------------------------------------------------
28 # These need to be auto-generated
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';
38 # -----------------------------------------------------------------------------
40 # xact=><true> : creates a storage transaction
41 # authtoken=>$token : the login session key
42 # -----------------------------------------------------------------------------
44 my( $class, %params ) = @_;
45 $class = ref($class) || $class;
46 my $self = bless( \%params, $class );
47 $self->{checked_perms} = {};
51 # -----------------------------------------------------------------------------
52 # Log the editor metadata along with the log string
53 # -----------------------------------------------------------------------------
55 my( $self, $lev, $str ) = @_;
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;
62 $logger->$lev("$s $str");
65 # -----------------------------------------------------------------------------
66 # Verifies the auth token and fetches the requestor object
67 # -----------------------------------------------------------------------------
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;
77 # -----------------------------------------------------------------------------
78 # Returns the last generated event
79 # -----------------------------------------------------------------------------
81 my( $self, $evt ) = @_;
82 $self->{event} = $evt if $evt;
83 return $self->{event};
86 # -----------------------------------------------------------------------------
87 # Clears the last caught event
88 # -----------------------------------------------------------------------------
91 $self->{event} = undef;
95 my( $self, $auth ) = @_;
96 $self->{authtoken} = $auth if $auth;
97 return $self->{authtoken};
100 # -----------------------------------------------------------------------------
101 # fetches the session, creating if necessary. If 'xact' is true on this
102 # object, a db session is created
103 # -----------------------------------------------------------------------------
105 my( $self, $session ) = @_;
106 $self->{session} = $session if $session;
108 if(!$self->{session}) {
109 $self->{session} = OpenSRF::AppSession->create('open-ils.cstore');
111 if( ! $self->{session} ) {
112 my $str = "Error creating storage session with OpenSRF::AppSession->create()!";
114 throw OpenSRF::EX::ERROR ($str);
117 $self->{session}->connect if $self->{xact} or $self->{connect};
118 $self->xact_start if $self->{xact};
120 return $self->{session};
124 # -----------------------------------------------------------------------------
125 # Starts a storage transaction
126 # -----------------------------------------------------------------------------
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;
135 # -----------------------------------------------------------------------------
136 # Commits a storage transaction
137 # -----------------------------------------------------------------------------
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;
146 # -----------------------------------------------------------------------------
147 # Rolls back a storage stransaction
148 # -----------------------------------------------------------------------------
151 $self->log(I, "rolling back db session");
152 return $self->request("open-ils.cstore.transaction.rollback");
156 # -----------------------------------------------------------------------------
157 # commits the db session and destroys the session
158 # -----------------------------------------------------------------------------
161 return unless $self->{xact};
163 $self->session->disconnect;
164 $self->{session} = undef;
167 # -----------------------------------------------------------------------------
168 # clears all object data. Does not commit the db transaction.
169 # -----------------------------------------------------------------------------
172 $self->session->disconnect if $self->{session};
173 $$self{$_} = undef for (keys %$self);
177 # -----------------------------------------------------------------------------
179 # -----------------------------------------------------------------------------
188 # -----------------------------------------------------------------------------
189 # Does a simple storage request
190 # -----------------------------------------------------------------------------
192 my( $self, $method, @params ) = @_;
196 my $argstr = __arg_to_string( (scalar(@params)) == 1 ? $params[0] : \@params);
198 $self->log(I, "request $method : $argstr");
201 $val = $self->session->request($method, @params)->gather(1);
205 $self->log(E, "request error $method : $argstr : $err");
213 # -----------------------------------------------------------------------------
214 # Sets / Returns the requstor object. This is set when checkauth succeeds.
215 # -----------------------------------------------------------------------------
217 my($self, $requestor) = @_;
218 $self->{requestor} = $requestor if $requestor;
219 return $self->{requestor};
224 # -----------------------------------------------------------------------------
225 # Holds the last data received from a storage call
226 # -----------------------------------------------------------------------------
228 my( $self, $data ) = @_;
229 $self->{data} = $data if defined $data;
230 return $self->{data};
234 # -----------------------------------------------------------------------------
235 # True if this perm has already been checked at this org
236 # -----------------------------------------------------------------------------
238 my( $self, $perm, $org ) = @_;
239 $self->{checked_perms}->{$org} = {}
240 unless $self->{checked_perms}->{$org};
241 my $checked = $self->{checked_perms}->{$org}->{$perm};
243 $self->{checked_perms}->{$org}->{$perm} = 1;
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
256 # If this perm at the given org has already been verified, true is returned
257 # and the perm is not re-checked
258 # -----------------------------------------------------------------------------
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);
269 my($self, $userid, $org, $perm) = @_;
270 my $s = $U->storagereq(
271 "open-ils.storage.permission.user_has_perm", $userid, $perm, $org );
274 my $e = OpenILS::Event->new('PERM_FAILURE', ilsperm => $perm, ilspermloc => $org);
284 # -----------------------------------------------------------------------------
285 # checks the appropriate perm for the operation
286 # -----------------------------------------------------------------------------
288 my( $self, $ptype, $action, $org ) = @_;
289 $org ||= $self->requestor->ws_ou;
290 my $perm = $PERMS{$ptype}{$action};
292 return undef if $self->perm_checked($perm, $org);
293 return $self->event unless $self->allowed($perm, $org);
295 $self->log(E, "no perm provided for $ptype.$action");
302 # -----------------------------------------------------------------------------
303 # Logs update actions to the activity log
304 # -----------------------------------------------------------------------------
306 my( $self, $type, $action, $arg ) = @_;
307 my $str = "$type.$action";
308 $str .= _prop_string($arg);
316 my @props = $obj->properties;
319 my $prop = $obj->$_() || "";
320 $prop = substr($prop, 0, 128) . "..." if length $prop > 131;
327 sub __arg_to_string {
329 return "" unless defined $arg;
330 return $arg->id if UNIVERSAL::isa($arg, "Fieldmapper");
331 return JSON->perl2JSON($arg);
335 # -----------------------------------------------------------------------------
336 # This does the actual storage query.
338 # 'search' calls become search_where calls and $arg can be a search hash or
339 # an array-ref of storage search options.
341 # 'retrieve' expects an id
342 # 'update' expects an object
343 # 'create' expects an object
344 # 'delete' expects an object
346 # All methods return true on success and undef on failure. On failure,
347 # $e->event is set to the generated event.
348 # Note: this method assumes that updating a non-changed object and
349 # thereby receiving a 0 from storage, is a successful update.
351 # The method will therefore return true so the caller can just do
352 # $e->update_blah($x) or return $e->event;
353 # The true value returned from storage for all methods will be stored in
354 # $e->data, until the next method is called.
356 # not-found events are generated on retrieve and serach methods.
357 # action=search methods will return [] (==true) if no data is found. If the
358 # caller is interested in the not found event, they can do:
359 # return $e->event unless @$results;
360 # -----------------------------------------------------------------------------
362 my( $self, $action, $type, $arg, $options ) = @_;
365 my $method = "open-ils.cstore.direct.$type.$action";
367 if( $action eq 'search' ) {
368 $method = "$method.atomic";
369 @arg = @$arg if ref($arg) eq 'ARRAY';
371 } elsif( $action eq 'batch_retrieve' ) {
373 @arg = ( { id => $arg } );
374 $method =~ s/batch_retrieve/search/o;
375 $method = "$method.atomic";
377 } elsif( $action eq 'retrieve_all' ) {
379 $method =~ s/retrieve_all/search/o;
380 @arg = ( { id => { '!=' => 0 } } );
381 $method = "$method.atomic";
384 $method =~ s/search/id_list/o if $options->{idlist};
386 # remove any stale events
389 if( $action eq 'update' or $action eq 'delete' or $action eq 'create' ) {
391 $logger->error("Attempt to update DB while not in a transaction : $method");
392 throw OpenSRF::EX::ERROR ("Attempt to update DB while not in a transaction : $method");
394 $self->log_activity($type, $action, $arg);
397 if($$options{checkperm}) {
398 my $a = ($action eq 'search') ? 'retrieve' : $action;
399 my $e = $self->_checkperm($type, $a, $$options{permorg});
410 $obj = $self->request($method, @arg);
411 } catch Error with { $err = shift; };
415 $self->log(I, "request returned no data");
417 if( $action eq 'retrieve' ) {
418 $self->event(_mk_not_found($type, $arg));
420 } elsif( $action eq 'update' or
421 $action eq 'delete' or $action eq 'create' ) {
422 my $evt = OpenILS::Event->new(
423 'DATABASE_UPDATE_FAILED', payload => $arg, debug => "$err" );
429 OpenILS::Event->new( 'DATABASE_QUERY_FAILED',
430 payload => $arg, debug => "$err" ));
437 if( $action eq 'create' and $obj == 0 ) {
438 my $evt = OpenILS::Event->new(
439 'DATABASE_UPDATE_FAILED', payload => $arg, debug => "$err" );
444 # If we havn't dealt with the error in a nice way, go ahead and throw it
447 OpenILS::Event->new( 'DATABASE_QUERY_FAILED',
448 payload => $arg, debug => "$err" ));
452 if( $action eq 'search' or $action eq 'batch_retrieve' or $action eq 'retrieve_all') {
453 $self->log(I, "$type.$action : returned ".scalar(@$obj). " result(s)");
454 $self->event(_mk_not_found($type, $arg)) unless @$obj;
457 $arg->id($obj) if $action eq 'create'; # grabs the id on create
458 $self->data($obj); # cache the data for convenience
460 return ($obj) ? $obj : 1;
465 my( $type, $arg ) = @_;
466 (my $t = $type) =~ s/\./_/og;
468 return OpenILS::Event->new("${t}_NOT_FOUND", payload => $arg);
473 # utility method for loading
477 $str =~ s/Fieldmapper:://o;
483 # -------------------------------------------------------------
484 # Load up the methods from the FM classes
485 # -------------------------------------------------------------
486 my $map = $Fieldmapper::fieldmap;
487 for my $object (keys %$map) {
488 my $obj = __fm2meth($object,'_');
489 my $type = __fm2meth($object, '.');
491 my $update = "update_$obj";
493 "sub $update {return shift()->runmethod('update', '$type', \@_);}";
496 my $retrieve = "retrieve_$obj";
498 "sub $retrieve {return shift()->runmethod('retrieve', '$type', \@_);}";
501 my $search = "search_$obj";
503 "sub $search {return shift()->runmethod('search', '$type', \@_);}";
506 my $create = "create_$obj";
508 "sub $create {return shift()->runmethod('create', '$type', \@_);}";
511 my $delete = "delete_$obj";
513 "sub $delete {return shift()->runmethod('delete', '$type', \@_);}";
516 my $bretrieve = "batch_retrieve_$obj";
518 "sub $bretrieve {return shift()->runmethod('batch_retrieve', '$type', \@_);}";
521 my $retrieveall = "retrieve_all_$obj";
523 "sub $retrieveall {return shift()->runmethod('retrieve_all', '$type', \@_);}";