3c7a9445d1150846fb3f8df47e0718967f1d36b0
[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::ScriptRunner;
10 use OpenILS::Application::AppUtils;
11 use OpenILS::Application::Circ::Holds;
12 use OpenSRF::Utils::Logger qw(:logger);
13
14 my $U                                                   = "OpenILS::Application::AppUtils";
15 my $holdcode                            = "OpenILS::Application::Circ::Holds";
16 $Data::Dumper::Indent   = 0;
17
18
19
20 __PACKAGE__->register_method(
21         method  => "copy_transit_receive",
22         api_name        => "open-ils.circ.copy_transit.receive",
23         notes           => q/
24                 Closes out a copy transit
25                 Requestor needs the COPY_TRANSIT_RECEIVE permission
26                 @param authtoken The login session key
27                 @param params An object of named params including
28                         copyid - the id of the copy in quest
29                         barcode - the barcode of the copy in question 
30                                 If copyid is not sent, this is used.
31                 @return A ROUTE_ITEM if the copy is destined for a different location.
32                         A SUCCESS event on success. Other events on error.
33         /);
34
35 sub copy_transit_receive {
36         my( $self, $client, $authtoken, $params ) = @_;
37         my %params = %$params;
38         my( $evt, $copy, $requestor );
39         ($requestor, $evt) = $U->checksesperm($authtoken, 'COPY_TRANSIT_RECEIVE');
40         return $evt if $evt;
41         ($copy, $evt) = $U->fetch_copy($params{copyid});
42         ($copy, $evt) = $U->fetch_copy_by_barcode($params{barcode}) unless $copy;
43         return $evt if $evt;
44         my $session = $U->start_db_session();
45         $evt = $self->transit_receive( $copy, $requestor, $session );
46         $U->commit_db_session($session) if $U->event_equals($evt,'SUCCESS');
47         return $evt;
48 }
49
50 # ------------------------------------------------------------------------------
51 # If the transit destination is different than the requestor's lib,
52 # a ROUTE_TO event is returned with the org set.
53 # If 
54 # ------------------------------------------------------------------------------
55 sub transit_receive {
56         my ( $class, $copy, $requestor, $session ) = @_;
57         $U->logmark;
58
59         my( $transit, $hold_transit, $evt );
60         my $copyid = $copy->id;
61
62         my $status_name = $U->copy_status_to_name($copy->status);
63         $logger->debug("Attempting transit receive on copy $copyid. Copy status is $status_name");
64
65         # fetch the transit
66         ($transit, $evt) = $U->fetch_open_transit_by_copy($copyid);
67         return $evt if $evt;
68
69         if( $transit->dest != $requestor->home_ou ) {
70                 $logger->activity("Fowarding transit on copy which is destined ".
71                         "for a different location. copy=$copyid,current ".
72                         "location=".$requestor->home_ou.",destination location=".$transit->dest);
73
74                 return OpenILS::Event->new('ROUTE_ITEM', org => $transit->dest );
75         }
76
77         # The transit is received, set the receive time
78         $transit->dest_recv_time('now');
79         my $r = $session->request(
80                 'open-ils.storage.direct.action.transit_copy.update', $transit )->gather(1);
81         return $U->DB_UPDATE_FAILED($transit) unless $r;
82
83         # if this is a hold transit, finalize the hold transit
84         my $ishold = 0;
85         if( ($evt = _finish_hold_transit( 
86                         $session, $requestor, $copy, $transit->id )) ) {
87                 $ishold = 1;
88                 return $evt unless $U->event_equals($evt, 'SUCCESS');
89                 $evt = undef;
90         }
91         
92         $U->logmark;
93
94         #recover this copy's status from the transit
95         $copy->status( $transit->copy_status );
96         return OpenILS::Event->new('SUCCESS', ishold => $ishold, payload => $copy);
97
98 }
99
100
101
102 # ------------------------------------------------------------------------------
103 # If we have a hold transit, set the copy's status to 'on holds shelf',
104 # update the copy, and return SUCCESS
105 # ------------------------------------------------------------------------------
106 sub _finish_hold_transit {
107         my( $session, $requestor, $copy, $transid ) = @_;
108         $U->logmark;
109         my ($hold_transit, $evt) = $U->fetch_hold_transit( $transid );
110         return undef unless $hold_transit;
111
112         my $s = $U->copy_status_from_name('on holds shelf');
113         $logger->info("Hold transit found: ".$hold_transit->id.". Routing to holds shelf");
114
115         $copy->status($s->id);
116         $U->update_copy( copy => $copy, 
117                 editor => $requestor->id, session => $session );
118
119         my $r = $session->request( 
120                 'open-ils.storage.direct.asset.copy.update', $copy )->gather(1);
121         return $U->DB_UPDATE_FAILED($copy) unless $r;
122
123         return OpenILS::Event->new('SUCCESS');
124 }
125
126
127 __PACKAGE__->register_method(
128         method  => "copy_transit_create",
129         api_name        => "open-ils.circ.copy_transit.create",
130         notes           => q/
131                 Creates a new copy transit.  Requestor must have the 
132                 CREATE_COPY_TRANSIT permission.
133                 @param authtoken The login session key
134                 @param params A param object containing the following keys:
135                         copyid          - the copy id
136                         destination     - the id of the org destination.  If not defined,
137                                 defaults to the copy's circ_lib
138                 @return SUCCESS event on success, other event on error
139         /);
140
141 sub copy_transit_create {
142
143         my( $self, $client, $authtoken, $params ) = @_;
144         my %params = %$params;
145
146         my( $requestor, $evt ) = 
147                 $U->checksesperm( $authtoken, 'CREATE_COPY_TRANSIT' );
148         return $evt if $evt;
149
150         my $copy;
151         ($copy,$evt) = $U->fetch_copy($params{copyid});
152         return $evt if $evt;
153
154         my $session             = $params{session} || $U->start_db_session();
155         my $source              = $requestor->home_ou;
156         my $dest                        = $params{destination} || $copy->circ_lib;
157         my $transit             = Fieldmapper::action::transit_copy->new;
158
159         $logger->activity("User ". $requestor->id ." creating a ".
160                 " new copy transit for copy ".$copy->id." to org $dest");
161
162         $transit->source($source);
163         $transit->dest($dest);
164         $transit->target_copy($copy->id);
165         $transit->source_send_time("now");
166         $transit->copy_status($copy->status);
167         
168         $logger->debug("Creating new copy_transit in DB");
169
170         my $s = $session->request(
171                 "open-ils.storage.direct.action.transit_copy.create", $transit )->gather(1);
172         return $U->DB_UPDATE_FAILED($transit) unless $s;
173         
174         my $stat = $U->copy_status_from_name('in transit');
175
176         $copy->status($stat->id); 
177         return $evt if ($evt = $U->update_copy(
178                 copy => $copy, editor => $requestor->id, session => $session ));
179
180         $U->commit_db_session($session) unless $params{session};
181
182         return OpenILS::Event->new('SUCCESS', 
183                 payload => { copy => $copy, transit => $transit } );
184 }
185         
186
187
188
189
190 666;