58670bf95b355cf1f72245f0ada7ceffa27484db
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / SIP / Item.pm
1 package OpenILS::SIP::Item;
2 use strict; use warnings;
3
4 use Sys::Syslog qw(syslog);
5
6 use OpenILS::SIP;
7 use OpenILS::SIP::Transaction;
8 use OpenILS::Application::AppUtils;
9 use OpenILS::Application::Circ::ScriptBuilder;
10 use Data::Dumper;
11 use OpenILS::Const qw/:const/;
12 use OpenSRF::Utils qw/:datetime/;
13 use DateTime::Format::ISO8601;
14 my $U = 'OpenILS::Application::AppUtils';
15
16 my %item_db;
17
18 sub new {
19     my ($class, $item_id) = @_;
20     my $type = ref($class) || $class;
21     my $self = bless( {}, $type );
22
23         syslog('LOG_DEBUG', "OILS: Loading item $item_id...");
24         return undef unless $item_id;
25
26         my $e = OpenILS::SIP->editor();
27
28         my $copy = $e->search_asset_copy(
29                 [
30                         { barcode => $item_id, deleted => 'f' },
31                         {
32                                 flesh => 3,
33                                 flesh_fields => {
34                                         acp => [ 'circ_lib', 'call_number', 'status' ],
35                                         acn => [ 'owning_lib', 'record' ],
36                                 }
37                         }
38                 ]
39         );
40
41
42         $copy = $$copy[0];
43
44         if(!$copy) {
45                 syslog("LOG_DEBUG", "OILS: Item '%s' : not found", $item_id);
46                 return undef;
47         }
48
49         my ($circ) = $U->fetch_open_circulation($copy->id);
50         if($circ) {
51                 # if i am checked out, set $self->{patron} to the user's barcode
52                 my $user = $e->retrieve_actor_user(
53                         [
54                                 $circ->usr,
55                                 { flesh => 1, flesh_fields => { "au" => [ 'card' ] } }
56                         ]
57                 );
58
59                 my $bc = ($user) ? $user->card->barcode : "";
60                 $self->{patron} = $bc;
61                 $self->{patron_object} = $user;
62
63                 syslog('LOG_DEBUG', "OILS: Open circulation exists on $item_id : user = $bc");
64         }
65
66         $self->{id}                     = $item_id;
67         $self->{copy}           = $copy;
68         $self->{volume} = $copy->call_number;
69         $self->{record} = $copy->call_number->record;
70         $self->{mods}           = $U->record_to_mvr($self->{record}) if $self->{record}->marc;
71
72         syslog("LOG_DEBUG", "OILS: Item('$item_id'): found with title '%s'", $self->title_id);
73
74         return $self;
75 }
76
77 sub run_attr_script {
78         my $self = shift;
79         return 1 if $self->{ran_script};
80         $self->{ran_script} = 1;
81
82         my $config = OpenILS::SIP->config();
83         my $path = $config->{implementation_config}->{scripts}->{path};
84         my $item_config_script = $config->{implementation_config}->{scripts}->{item_config};
85
86         syslog('LOG_DEBUG', "OILS: Script path = $path, Item config script = $item_config_script");
87
88         my $runner = 
89                 OpenILS::Application::Circ::ScriptBuilder->build(
90                         {
91                                 copy => $self->{copy},
92                                 editor => OpenILS::SIP->editor(),
93                         }
94                 );
95
96         $runner->add_path($path);
97         $runner->load($item_config_script);
98
99         unless( $self->{item_config_result} = $runner->run ) {
100                 $runner->cleanup;
101                 warn "Item config script [$path : $item_config_script] failed to run: $@\n";
102                 syslog('LOG_ERR', "OILS: Item config script [$path : $item_config_script] failed to run: $@");
103                 return undef;
104         }
105
106         $runner->cleanup;
107         return 1;
108 }
109
110 sub magnetic {
111     my $self = shift;
112          return 0 unless $self->run_attr_script;
113          my $mag = $self->{item_config_result}->{magneticMedia};
114          syslog('LOG_DEBUG', "OILS: magnetic = $mag");
115          return ($mag and $mag eq 't') ? 1 : 0;
116 }
117
118 sub sip_media_type {
119     my $self = shift;
120          return 0 unless $self->run_attr_script;
121          my $media = $self->{item_config_result}->{SIPMediaType};
122          syslog('LOG_DEBUG', "OILS: media type = $media");
123          return ($media) ? $media : '001';
124 }
125
126 sub sip_item_properties {
127     my $self = shift;
128          return "";
129 }
130
131 sub status_update {
132     my ($self, $props) = @_;
133     my $status = OpenILS::SIP::Transaction->new;
134     $self->{sip_item_properties} = $props;
135     $status->{ok} = 1;
136     return $status;
137 }
138
139
140 sub id {
141     my $self = shift;
142     return $self->{id};
143 }
144
145 sub title_id {
146     my $self = shift;
147     return ($self->{mods}) ? $self->{mods}->title : $self->{copy}->dummy_title;
148 }
149
150 sub permanent_location {
151     my $self = shift;
152          return $self->{volume}->owning_lib->name;
153 }
154
155 sub current_location {
156     my $self = shift;
157          return $self->{copy}->circ_lib->name;
158 }
159
160
161 # 2 chars 0-99 
162 # 01 Other
163 # 02 On order
164 # 03 Available
165 # 04 Charged
166 # 05 Charged; not to be recalled until earliest recall date
167 # 06 In process
168 # 07 Recalled
169 # 08 Waiting on hold shelf
170 # 09 Waiting to be re-shelved
171 # 10 In transit between library locations
172 # 11 Claimed returned
173 # 12 Lost
174 # 13 Missing 
175 sub sip_circulation_status {
176         my $self = shift;
177         my $stat = $self->{copy}->status->id;
178
179         return '02' if $stat == OILS_COPY_STATUS_ON_ORDER;
180         return '03' if $stat == OILS_COPY_STATUS_AVAILABLE;
181         return '04' if $stat == OILS_COPY_STATUS_CHECKED_OUT;
182         return '06' if $stat == OILS_COPY_STATUS_IN_PROCESS;
183         return '08' if $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF;
184         return '09' if $stat == OILS_COPY_STATUS_RESHELVING;
185         return '10' if $stat == OILS_COPY_STATUS_IN_TRANSIT;
186         return '12' if $stat == OILS_COPY_STATUS_LOST;
187         return '13' if $stat == OILS_COPY_STATUS_MISSING;
188                 
189         return 01;
190 }
191
192 sub sip_security_marker {
193     return '02';
194 }
195
196 sub sip_fee_type {
197     return '01';
198 }
199
200 sub fee {
201     my $self = shift;
202          return 0;
203 }
204
205
206 sub fee_currency {
207         my $self = shift;
208         return OpenILS::SIP->config()->{implementation_config}->{currency};
209 }
210
211 sub owner {
212     my $self = shift;
213          return $self->{volume}->owning_lib->name;
214 }
215
216 sub hold_queue {
217     my $self = shift;
218          return [];
219 }
220
221 sub hold_queue_position {
222     my ($self, $patron_id) = @_;
223          return 1;
224 }
225
226 sub due_date {
227         my $self = shift;
228         my $e = OpenILS::SIP->editor();
229
230         my $circ = $e->search_action_circulation(
231                 { target_copy => $self->{copy}->id, stop_fines => undef } )->[0];
232
233         if(!$circ) {
234                 # if not, lets look for other circs we can check in
235                 $circ = $e->search_action_circulation(
236                         { 
237                                 target_copy => $self->{copy}->id, 
238                                 xact_finish => undef,
239                                 stop_fines      => [ 'CLAIMSRETURNED', 'LOST', 'LONGOVERDUE' ]
240                         } )->[0];
241         }
242
243         return 0 unless $circ;
244         my $due = OpenILS::SIP->format_date($circ->due_date);
245         syslog('LOG_DEBUG', "Item due date = $due");
246         return $due;
247 }
248
249 sub recall_date {
250     my $self = shift;
251     return 0;
252 }
253
254 sub hold_pickup_date {
255     my $self = shift;
256          return 0;
257 }
258
259 # message to display on console
260 sub screen_msg {
261     my $self = shift;
262     return $self->{screen_msg} || '';
263 }
264
265
266 # reciept printer
267 sub print_line {
268      my $self = shift;
269      return $self->{print_line} || '';
270 }
271
272
273 # An item is available for a patron if
274 # 1) It's not checked out and (there's no hold queue OR patron
275 #    is at the front of the queue)
276 # OR
277 # 2) It's checked out to the patron and there's no hold queue
278 sub available {
279         my ($self, $for_patron) = @_;
280
281         my $stat = $self->{copy}->status->id;
282         return 1 if 
283                 $stat == OILS_COPY_STATUS_AVAILABLE or
284                 $stat == OILS_COPY_STATUS_RESHELVING;
285         
286         return 0;
287 }
288
289
290 1;