]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Circ/Transit.pm
moved to cstore in the process of chasing a bug
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Circ / Transit.pm
1 package OpenILS::Application::Circ::Transit;
2 use base 'OpenSRF::Application';
3 use strict; use warnings;
4 use OpenSRF::EX qw(:try);
5 use Data::Dumper;
6 use OpenSRF::Utils;
7 use OpenSRF::Utils::Cache;
8 use Digest::MD5 qw(md5_hex);
9 use OpenILS::Utils::CStoreEditor qw/:funcs/;
10 use OpenILS::Application::AppUtils;
11 use OpenILS::Application::Circ::Holds;
12 use OpenSRF::Utils::Logger qw(:logger);
13 use OpenSRF::AppSession;
14
15 my $U                                                   = "OpenILS::Application::AppUtils";
16 my $holdcode                            = "OpenILS::Application::Circ::Holds";
17 $Data::Dumper::Indent   = 0;
18
19
20
21 __PACKAGE__->register_method(
22         method  => "copy_transit_receive",
23         api_name        => "open-ils.circ.copy_transit.receive",
24         notes           => q/
25                 Closes out a copy transit
26                 Requestor needs the COPY_TRANSIT_RECEIVE permission
27                 @param authtoken The login session key
28                 @param params An object of named params including
29                         copyid - the id of the copy in quest
30                         barcode - the barcode of the copy in question 
31                                 If copyid is not sent, this is used.
32                 @return A ROUTE_ITEM if the copy is destined for a different location.
33                         A SUCCESS event on success. Other events on error.
34         /);
35
36 sub copy_transit_receive {
37         my( $self, $client, $authtoken, $params ) = @_;
38         my %params = %$params;
39         my( $evt, $copy, $requestor );
40         ($requestor, $evt) = $U->checksesperm($authtoken, 'COPY_TRANSIT_RECEIVE');
41         return $evt if $evt;
42         ($copy, $evt) = $U->fetch_copy($params{copyid});
43         ($copy, $evt) = $U->fetch_copy_by_barcode($params{barcode}) unless $copy;
44         return $evt if $evt;
45         my $session = $U->start_db_session();
46         $evt = $self->transit_receive( $copy, $requestor, $session );
47         $U->commit_db_session($session) if $U->event_equals($evt,'SUCCESS');
48         return $evt;
49 }
50
51 # ------------------------------------------------------------------------------
52 # If the transit destination is different than the requestor's lib,
53 # a ROUTE_TO event is returned with the org set.
54 # If 
55 # ------------------------------------------------------------------------------
56 sub transit_receive {
57         my ( $class, $copy, $requestor, $session ) = @_;
58         $U->logmark;
59
60         my( $transit, $evt );
61         my $copyid = $copy->id;
62
63         my $status_name = $U->copy_status_to_name($copy->status);
64         $logger->debug("Attempting transit receive on copy $copyid. Copy status is $status_name");
65
66         # fetch the transit
67         ($transit, $evt) = $U->fetch_open_transit_by_copy($copyid);
68         return $evt if $evt;
69
70         if( $transit->dest != $requestor->home_ou ) {
71                 $logger->activity("Fowarding transit on copy which is destined ".
72                         "for a different location. copy=$copyid,current ".
73                         "location=".$requestor->home_ou.",destination location=".$transit->dest);
74
75                 return OpenILS::Event->new('ROUTE_ITEM', org => $transit->dest );
76         }
77
78         # The transit is received, set the receive time
79         $transit->dest_recv_time('now');
80         my $r = $session->request(
81                 'open-ils.storage.direct.action.transit_copy.update', $transit )->gather(1);
82         return $U->DB_UPDATE_FAILED($transit) unless $r;
83
84         my $ishold      = 0;
85         my ($ht)                = $U->fetch_hold_transit( $transit->id );
86         if($ht) {
87                 $logger->info("Hold transit found in transit receive...");
88                 $ishold = 1;
89         }
90
91         $logger->info("Recovering original copy status in transit: ".$transit->copy_status);
92         $copy->status( $transit->copy_status );
93         return $evt if ( $evt = 
94                 $U->update_copy( copy => $copy, editor => $requestor->id, session => $session ));
95
96         return OpenILS::Event->new('SUCCESS', ishold => $ishold, 
97                 payload => { transit => $transit, holdtransit => $ht } );
98 }
99
100
101
102
103
104 __PACKAGE__->register_method(
105         method  => "copy_transit_create",
106         api_name        => "open-ils.circ.copy_transit.create",
107         notes           => q/
108                 Creates a new copy transit.  Requestor must have the 
109                 CREATE_COPY_TRANSIT permission.
110                 @param authtoken The login session key
111                 @param params A param object containing the following keys:
112                         copyid          - the copy id
113                         destination     - the id of the org destination.  If not defined,
114                                 defaults to the copy's circ_lib
115                 @return SUCCESS event on success, other event on error
116         /);
117
118 sub copy_transit_create {
119
120         my( $self, $client, $authtoken, $params ) = @_;
121         my %params = %$params;
122
123         my( $requestor, $evt ) = 
124                 $U->checksesperm( $authtoken, 'CREATE_COPY_TRANSIT' );
125         return $evt if $evt;
126
127         my $copy;
128         ($copy,$evt) = $U->fetch_copy($params{copyid});
129         return $evt if $evt;
130
131         my $session             = $params{session} || $U->start_db_session();
132         my $source              = $requestor->home_ou;
133         my $dest                        = $params{destination} || $copy->circ_lib;
134         my $transit             = Fieldmapper::action::transit_copy->new;
135
136         $logger->activity("User ". $requestor->id ." creating a ".
137                 " new copy transit for copy ".$copy->id." to org $dest");
138
139         $transit->source($source);
140         $transit->dest($dest);
141         $transit->target_copy($copy->id);
142         $transit->source_send_time("now");
143         $transit->copy_status($copy->status);
144         
145         $logger->debug("Creating new copy_transit in DB");
146
147         my $s = $session->request(
148                 "open-ils.storage.direct.action.transit_copy.create", $transit )->gather(1);
149         return $U->DB_UPDATE_FAILED($transit) unless $s;
150         
151         my $stat = $U->copy_status_from_name('in transit');
152
153         $copy->status($stat->id); 
154         return $evt if ($evt = $U->update_copy(
155                 copy => $copy, editor => $requestor->id, session => $session ));
156
157         $U->commit_db_session($session) unless $params{session};
158
159         return OpenILS::Event->new('SUCCESS', 
160                 payload => { copy => $copy, transit => $transit } );
161 }
162
163
164 __PACKAGE__->register_method(
165         method => 'abort_transit',
166         api_name        => 'open-ils.circ.transit.abort',
167         signature       => q/
168                 Deletes a cleans up a transit
169         /
170 );
171
172 sub abort_transit {
173         my( $self, $conn, $authtoken, $params ) = @_;
174
175         my $copyid              = $$params{copyid};
176         my $barcode             = $$params{barcode};
177         my $transitid   = $$params{transitid};
178
179         my $copy;
180         my $transit;
181         my $holdtransit;
182         my $hold;
183         my $evt;
184
185         my $e = new_editor(xact => 1, authtoken => $authtoken);
186         return $e->event unless $e->checkauth;
187         return $e->event unless $e->allowed('ABORT_TRANSIT');
188
189         # ---------------------------------------------------------------------
190         # Find the related copy and/or transit based on whatever data we have
191         # XXX Move to editor calls
192         if( $barcode ) {
193                 ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
194                 return $evt if $evt;
195
196         } elsif( $copyid ) {
197                 ($copy, $evt) = $U->fetch_copy($copyid);
198                 return $evt if $evt;
199         }
200
201         if( $transitid ) {
202                 ($transit, $evt) = $U->fetch_transit($transitid);
203                 return $evt if $evt;
204
205         } else {
206                 ($transit, $evt) = $U->fetch_open_transit_by_copy($copy->id);
207                 return $evt if $evt;
208         }
209
210         if(!$copy) {
211                 ($copy, $evt) = $U->fetch_copy($transit->target_copy);
212                 return $evt if $evt;
213         }
214         # ---------------------------------------------------------------------
215
216
217         if( $transit->dest != $e->requestor->ws_ou 
218                 and $transit->source != $e->requestor->ws_ou ) {
219                 return $e->event unless $e->allowed('ABORT_REMOTE_TRANIST', $e->requestor->ws_ou);
220         }
221
222         # recover the copy status
223         $copy->status( $transit->copy_status );
224         $copy->editor( $e->requestor->id );
225         $copy->edit_date('now');
226
227         ($holdtransit) = $U->fetch_hold_transit($transit->id);
228
229         # update / delete the objects
230         #my $session = $U->start_db_session();
231
232
233         # if this is a hold transit, un-capture/un-target the hold
234         if($holdtransit) {
235                 ($hold, $evt) = $U->fetch_hold($holdtransit->hold);                     
236                 return $evt if $evt;
237                 $evt = $holdcode->_reset_hold( $e->requestor, $hold );
238                 return $evt if $evt;
239         }
240
241         return $e->event unless $e->delete_action_transit_copy($transit);
242         return $e->event unless $e->update_asset_copy($copy);
243
244         $e->commit;
245         return 1;
246 }
247
248
249 __PACKAGE__->register_method(
250         method          => 'get_open_copy_transit',
251         api_name                => 'open-ils.circ.open_copy_transit.retrieve',
252         signature       => q/
253                 Retrieves the open transit object for a given copy
254                 @param auth The login session key
255                 @param copyid The id of the copy
256                 @return Transit object
257  /
258 );
259
260 sub get_open_copy_transit {
261         my( $self, $conn, $auth, $copyid ) = @_;        
262         my $e = new_editor(authtoken=>$auth);
263         return $e->event unless $e->checkauth;
264         return $e->event unless $e->allowed('VIEW_USER'); # XXX rely on editor perms
265         my $t = $e->search_action_transit_copy(
266                 { target_copy => $copyid, dest_recv_time => undef });
267         return $e->event unless @$t;
268         return $$t[0];
269 }
270
271
272         
273
274
275
276
277 1;