(bug #3020) add a grace period to subscriptions
[koha.git] / C4 / Serials.pm
1 package C4::Serials;    #assumes C4/Serials.pm
2
3 # Copyright 2000-2002 Katipo Communications
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
10 # version.
11 #
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA  02111-1307 USA
19
20
21 use strict;
22 use C4::Dates qw(format_date format_date_in_iso);
23 use Date::Calc qw(:all);
24 use POSIX qw(strftime);
25 use C4::Suggestions;
26 use C4::Koha;
27 use C4::Biblio;
28 use C4::Items;
29 use C4::Search;
30 use C4::Letters;
31 use C4::Log; # logaction
32 use C4::Debug;
33
34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
35
36 BEGIN {
37         $VERSION = 3.01;        # set version for version checking
38         require Exporter;
39         @ISA    = qw(Exporter);
40         @EXPORT = qw(
41     &NewSubscription    &ModSubscription    &DelSubscription    &GetSubscriptions
42     &GetSubscription    &CountSubscriptionFromBiblionumber      &GetSubscriptionsFromBiblionumber
43     &GetFullSubscriptionsFromBiblionumber   &GetFullSubscription &ModSubscriptionHistory
44     &HasSubscriptionExpired &GetExpirationDate &abouttoexpire
45     
46     &GetNextSeq         &NewIssue           &ItemizeSerials    &GetSerials
47     &GetLatestSerials   &ModSerialStatus    &GetNextDate       &GetSerials2
48     &ReNewSubscription  &GetLateIssues      &GetLateOrMissingIssues
49     &GetSerialInformation                   &AddItem2Serial
50     &PrepareSerialsData &GetNextExpected    &ModNextExpected
51     
52     &UpdateClaimdateIssues
53     &GetSuppliersWithLateIssues             &getsupplierbyserialid
54     &GetDistributedTo   &SetDistributedTo
55     &getroutinglist     &delroutingmember   &addroutingmember
56     &reorder_members
57     &check_routing &updateClaim &removeMissingIssue
58     
59     &old_newsubscription &old_modsubscription &old_getserials
60         );
61 }
62
63 =head2 GetSuppliersWithLateIssues
64
65 =head1 NAME
66
67 C4::Serials - Give functions for serializing.
68
69 =head1 SYNOPSIS
70
71   use C4::Serials;
72
73 =head1 DESCRIPTION
74
75 Give all XYZ functions
76
77 =head1 FUNCTIONS
78
79 =over 4
80
81 %supplierlist = &GetSuppliersWithLateIssues
82
83 this function get all suppliers with late issues.
84
85 return :
86 the supplierlist into a hash. this hash containts id & name of the supplier
87
88 =back
89
90 =cut
91
92 sub GetSuppliersWithLateIssues {
93     my $dbh   = C4::Context->dbh;
94     my $query = qq|
95         SELECT DISTINCT id, name
96         FROM            subscription 
97         LEFT JOIN       serial ON serial.subscriptionid=subscription.subscriptionid
98         LEFT JOIN       aqbooksellers ON subscription.aqbooksellerid = aqbooksellers.id
99         WHERE           subscription.subscriptionid = serial.subscriptionid
100         AND             (planneddate < now() OR serial.STATUS = 3 OR serial.STATUS = 4)
101         ORDER BY name
102     |;
103     my $sth = $dbh->prepare($query);
104     $sth->execute;
105     my %supplierlist;
106     while ( my ( $id, $name ) = $sth->fetchrow ) {
107         $supplierlist{$id} = $name;
108     }
109     return %supplierlist;
110 }
111
112 =head2 GetLateIssues
113
114 =over 4
115
116 @issuelist = &GetLateIssues($supplierid)
117
118 this function select late issues on database
119
120 return :
121 the issuelist into an table. Each line of this table containts a ref to a hash which it containts
122 name,title,planneddate,serialseq,serial.subscriptionid from tables : subscription, serial & biblio
123
124 =back
125
126 =cut
127
128 sub GetLateIssues {
129     my ($supplierid) = @_;
130     my $dbh = C4::Context->dbh;
131     my $sth;
132     if ($supplierid) {
133         my $query = qq|
134             SELECT     name,title,planneddate,serialseq,serial.subscriptionid
135             FROM       subscription
136             LEFT JOIN  serial ON subscription.subscriptionid = serial.subscriptionid
137             LEFT JOIN  biblio ON biblio.biblionumber = subscription.biblionumber
138             LEFT JOIN  aqbooksellers ON subscription.aqbooksellerid = aqbooksellers.id
139             WHERE      ((planneddate < now() AND serial.STATUS =1) OR serial.STATUS = 3)
140             AND        subscription.aqbooksellerid=$supplierid
141             ORDER BY   title
142         |;
143         $sth = $dbh->prepare($query);
144     }
145     else {
146         my $query = qq|
147             SELECT     name,title,planneddate,serialseq,serial.subscriptionid
148             FROM       subscription
149             LEFT JOIN  serial ON subscription.subscriptionid = serial.subscriptionid
150             LEFT JOIN  biblio ON biblio.biblionumber = subscription.biblionumber
151             LEFT JOIN  aqbooksellers ON subscription.aqbooksellerid = aqbooksellers.id
152             WHERE      ((planneddate < now() AND serial.STATUS =1) OR serial.STATUS = 3)
153             ORDER BY   title
154         |;
155         $sth = $dbh->prepare($query);
156     }
157     $sth->execute;
158     my @issuelist;
159     my $last_title;
160     my $odd   = 0;
161     my $count = 0;
162     while ( my $line = $sth->fetchrow_hashref ) {
163         $odd++ unless $line->{title} eq $last_title;
164         $line->{title} = "" if $line->{title} eq $last_title;
165         $last_title = $line->{title} if ( $line->{title} );
166         $line->{planneddate} = format_date( $line->{planneddate} );
167         $count++;
168         push @issuelist, $line;
169     }
170     return $count, @issuelist;
171 }
172
173 =head2 GetSubscriptionHistoryFromSubscriptionId
174
175 =over 4
176
177 $sth = GetSubscriptionHistoryFromSubscriptionId()
178 this function just prepare the SQL request.
179 After this function, don't forget to execute it by using $sth->execute($subscriptionid)
180 return :
181 $sth = $dbh->prepare($query).
182
183 =back
184
185 =cut
186
187 sub GetSubscriptionHistoryFromSubscriptionId() {
188     my $dbh   = C4::Context->dbh;
189     my $query = qq|
190         SELECT *
191         FROM   subscriptionhistory
192         WHERE  subscriptionid = ?
193     |;
194     return $dbh->prepare($query);
195 }
196
197 =head2 GetSerialStatusFromSerialId
198
199 =over 4
200
201 $sth = GetSerialStatusFromSerialId();
202 this function just prepare the SQL request.
203 After this function, don't forget to execute it by using $sth->execute($serialid)
204 return :
205 $sth = $dbh->prepare($query).
206
207 =back
208
209 =cut
210
211 sub GetSerialStatusFromSerialId() {
212     my $dbh   = C4::Context->dbh;
213     my $query = qq|
214         SELECT status
215         FROM   serial
216         WHERE  serialid = ?
217     |;
218     return $dbh->prepare($query);
219 }
220
221 =head2 GetSerialInformation
222
223 =over 4
224
225 $data = GetSerialInformation($serialid);
226 returns a hash containing :
227   items : items marcrecord (can be an array)
228   serial table field
229   subscription table field
230   + information about subscription expiration
231   
232 =back
233
234 =cut
235
236 sub GetSerialInformation {
237     my ($serialid) = @_;
238     my $dbh        = C4::Context->dbh;
239     my $query      = qq|
240         SELECT serial.*, serial.notes as sernotes, serial.status as serstatus,subscription.*,subscription.subscriptionid as subsid |;
241        if (C4::Context->preference('IndependantBranches') && 
242               C4::Context->userenv && 
243               C4::Context->userenv->{'flags'} != 1 && C4::Context->userenv->{'branch'}){
244                 $query.="
245       , ((subscription.branchcode <>\"".C4::Context->userenv->{'branch'}."\") and subscription.branchcode <>\"\" and subscription.branchcode IS NOT NULL) as cannotedit ";
246         }
247             $query .= qq|             
248         FROM   serial LEFT JOIN subscription ON subscription.subscriptionid=serial.subscriptionid
249         WHERE  serialid = ?
250     |;
251     my $rq = $dbh->prepare($query);
252     $rq->execute($serialid);
253     my $data = $rq->fetchrow_hashref;
254     # create item information if we have serialsadditems for this subscription
255     if ( $data->{'serialsadditems'} ) {
256         my $queryitem=$dbh->prepare("SELECT itemnumber from serialitems where serialid=?");
257         $queryitem->execute($serialid);
258         my $itemnumbers=$queryitem->fetchall_arrayref([0]);
259         if (scalar(@$itemnumbers)>0){
260             foreach my $itemnum (@$itemnumbers) {
261                 #It is ASSUMED that GetMarcItem ALWAYS WORK...
262                 #Maybe GetMarcItem should return values on failure
263                 $debug and warn "itemnumber :$itemnum->[0], bibnum :".$data->{'biblionumber'};
264                 my $itemprocessed =
265                   PrepareItemrecordDisplay( $data->{'biblionumber'}, $itemnum->[0] , $data );
266                 $itemprocessed->{'itemnumber'}   = $itemnum->[0];
267                 $itemprocessed->{'itemid'}       = $itemnum->[0];
268                 $itemprocessed->{'serialid'}     = $serialid;
269                 $itemprocessed->{'biblionumber'} = $data->{'biblionumber'};
270                 push @{ $data->{'items'} }, $itemprocessed;
271             }
272         }
273         else {
274             my $itemprocessed =
275               PrepareItemrecordDisplay( $data->{'biblionumber'}, '', $data );
276             $itemprocessed->{'itemid'}       = "N$serialid";
277             $itemprocessed->{'serialid'}     = $serialid;
278             $itemprocessed->{'biblionumber'} = $data->{'biblionumber'};
279             $itemprocessed->{'countitems'}   = 0;
280             push @{ $data->{'items'} }, $itemprocessed;
281         }
282     }
283     $data->{ "status" . $data->{'serstatus'} } = 1;
284     $data->{'subscriptionexpired'} =
285       HasSubscriptionExpired( $data->{'subscriptionid'} ) && $data->{'status'}==1;
286     $data->{'abouttoexpire'} =
287       abouttoexpire( $data->{'subscriptionid'} );
288     return $data;
289 }
290
291 =head2 AddItem2Serial
292
293 =over 4
294
295 $data = AddItem2Serial($serialid,$itemnumber);
296 Adds an itemnumber to Serial record
297
298 =back
299
300 =cut
301
302 sub AddItem2Serial {
303     my ( $serialid, $itemnumber ) = @_;
304     my $dbh   = C4::Context->dbh;
305     my $rq = $dbh->prepare("INSERT INTO `serialitems` SET serialid=? , itemnumber=?");
306     $rq->execute($serialid, $itemnumber);
307     return $rq->rows;
308 }
309
310 =head2 UpdateClaimdateIssues
311
312 =over 4
313
314 UpdateClaimdateIssues($serialids,[$date]);
315
316 Update Claimdate for issues in @$serialids list with date $date 
317 (Take Today if none)
318
319 =back
320
321 =cut
322
323 sub UpdateClaimdateIssues {
324     my ( $serialids, $date ) = @_;
325     my $dbh   = C4::Context->dbh;
326     $date = strftime("%Y-%m-%d",localtime) unless ($date);
327     my $query = "
328         UPDATE serial SET claimdate=$date,status=7
329         WHERE  serialid in ".join (",",@$serialids);
330     ;
331     my $rq = $dbh->prepare($query);
332     $rq->execute;
333     return $rq->rows;
334 }
335
336 =head2 GetSubscription
337
338 =over 4
339
340 $subs = GetSubscription($subscriptionid)
341 this function get the subscription which has $subscriptionid as id.
342 return :
343 a hashref. This hash containts
344 subscription, subscriptionhistory, aqbudget.bookfundid, biblio.title
345
346 =back
347
348 =cut
349
350 sub GetSubscription {
351     my ($subscriptionid) = @_;
352     my $dbh              = C4::Context->dbh;
353     my $query            = qq(
354         SELECT  subscription.*,
355                 subscriptionhistory.*,
356                 subscriptionhistory.enddate as histenddate,
357                 aqbudget.bookfundid,
358                 aqbooksellers.name AS aqbooksellername,
359                 biblio.title AS bibliotitle,
360                 subscription.biblionumber as bibnum);
361        if (C4::Context->preference('IndependantBranches') && 
362               C4::Context->userenv && 
363               C4::Context->userenv->{'flags'} != 1 && C4::Context->userenv->{'branch'}){
364                 $query.="
365       , ((subscription.branchcode <>\"".C4::Context->userenv->{'branch'}."\") and subscription.branchcode <>\"\" and subscription.branchcode IS NOT NULL) as cannotedit ";
366         }
367             $query .= qq(             
368        FROM subscription
369        LEFT JOIN subscriptionhistory ON subscription.subscriptionid=subscriptionhistory.subscriptionid
370        LEFT JOIN aqbudget ON subscription.aqbudgetid=aqbudget.aqbudgetid
371        LEFT JOIN aqbooksellers ON subscription.aqbooksellerid=aqbooksellers.id
372        LEFT JOIN biblio ON biblio.biblionumber=subscription.biblionumber
373        WHERE subscription.subscriptionid = ?
374     );
375 #     if (C4::Context->preference('IndependantBranches') && 
376 #         C4::Context->userenv && 
377 #         C4::Context->userenv->{'flags'} != 1){
378 # #       $debug and warn "flags: ".C4::Context->userenv->{'flags'};
379 #       $query.=" AND subscription.branchcode IN ('".C4::Context->userenv->{'branch'}."',\"\")";
380 #     }
381         $debug and warn "query : $query\nsubsid :$subscriptionid";
382     my $sth = $dbh->prepare($query);
383     $sth->execute($subscriptionid);
384     return $sth->fetchrow_hashref;
385 }
386
387 =head2 GetFullSubscription
388
389 =over 4
390
391    \@res = GetFullSubscription($subscriptionid)
392    this function read on serial table.
393
394 =back
395
396 =cut
397
398 sub GetFullSubscription {
399     my ($subscriptionid) = @_;
400     my $dbh            = C4::Context->dbh;
401     my $query          = qq|
402   SELECT    serial.serialid,
403             serial.serialseq,
404             serial.planneddate, 
405             serial.publisheddate, 
406             serial.status, 
407             serial.notes as notes,
408             year(IF(serial.publisheddate="00-00-0000",serial.planneddate,serial.publisheddate)) as year,
409             aqbudget.bookfundid,aqbooksellers.name as aqbooksellername,
410             biblio.title as bibliotitle,
411             subscription.branchcode AS branchcode,
412             subscription.subscriptionid AS subscriptionid |;
413     if (C4::Context->preference('IndependantBranches') && 
414         C4::Context->userenv && 
415         C4::Context->userenv->{'flags'} != 1 && C4::Context->userenv->{'branch'}){
416       $query.="
417       , ((subscription.branchcode <>\"".C4::Context->userenv->{'branch'}."\") and subscription.branchcode <>\"\" and subscription.branchcode IS NOT NULL) as cannotedit ";
418     }
419     $query.=qq|
420   FROM      serial 
421   LEFT JOIN subscription ON 
422           (serial.subscriptionid=subscription.subscriptionid )
423   LEFT JOIN aqbudget ON subscription.aqbudgetid=aqbudget.aqbudgetid 
424   LEFT JOIN aqbooksellers on subscription.aqbooksellerid=aqbooksellers.id 
425   LEFT JOIN biblio on biblio.biblionumber=subscription.biblionumber 
426   WHERE     serial.subscriptionid = ? 
427   ORDER BY year DESC,
428           IF(serial.publisheddate="00-00-0000",serial.planneddate,serial.publisheddate) DESC,
429           serial.subscriptionid
430           |;
431         $debug and warn "GetFullSubscription query: $query";   
432     my $sth = $dbh->prepare($query);
433     $sth->execute($subscriptionid);
434     return $sth->fetchall_arrayref({});
435 }
436
437
438 =head2 PrepareSerialsData
439
440 =over 4
441
442    \@res = PrepareSerialsData($serialinfomation)
443    where serialinformation is a hashref array
444
445 =back
446
447 =cut
448
449 sub PrepareSerialsData{
450     my ($lines)=@_;
451     my %tmpresults;
452     my $year;
453     my @res;
454     my $startdate;
455     my $aqbooksellername;
456     my $bibliotitle;
457     my @loopissues;
458     my $first;
459     my $previousnote = "";
460     
461     foreach  my $subs ( @$lines ) {
462         $subs->{'publisheddate'} =
463           ( $subs->{'publisheddate'}
464             ? format_date( $subs->{'publisheddate'} )
465             : "XXX" );
466         $subs->{'planneddate'} = format_date( $subs->{'planneddate'} );
467         $subs->{ "status" . $subs->{'status'} } = 1;
468
469 #         $subs->{'notes'} = $subs->{'notes'} eq $previousnote?"":$subs->{notes};
470         if ( $subs->{'year'} && $subs->{'year'} ne "" ) {
471             $year = $subs->{'year'};
472         }
473         else {
474             $year = "manage";
475         }
476         if ( $tmpresults{$year} ) {
477             push @{ $tmpresults{$year}->{'serials'} }, $subs;
478         }
479         else {
480             $tmpresults{$year} = {
481                 'year' => $year,
482
483                 #               'startdate'=>format_date($subs->{'startdate'}),
484                 'aqbooksellername' => $subs->{'aqbooksellername'},
485                 'bibliotitle'      => $subs->{'bibliotitle'},
486                 'serials'          => [$subs],
487                 'first'            => $first,
488 #                 'branchcode'       => $subs->{'branchcode'},
489 #                 'subscriptionid'   => $subs->{'subscriptionid'},
490             };
491         }
492
493         #         $previousnote=$subs->{notes};
494     }
495     foreach my $key ( sort { $b cmp $a } keys %tmpresults ) {
496         push @res, $tmpresults{$key};
497     }
498     $res[0]->{'first'}=1;  
499     return \@res;
500 }
501
502 =head2 GetSubscriptionsFromBiblionumber
503
504 \@res = GetSubscriptionsFromBiblionumber($biblionumber)
505 this function get the subscription list. it reads on subscription table.
506 return :
507 table of subscription which has the biblionumber given on input arg.
508 each line of this table is a hashref. All hashes containt
509 startdate, histstartdate,opacnote,missinglist,recievedlist,periodicity,status & enddate
510
511 =cut
512
513 sub GetSubscriptionsFromBiblionumber {
514     my ($biblionumber) = @_;
515     my $dbh            = C4::Context->dbh;
516     my $query          = qq(
517         SELECT subscription.*,
518                branches.branchname,
519                subscriptionhistory.*,
520                subscriptionhistory.enddate as histenddate, 
521                aqbudget.bookfundid,
522                aqbooksellers.name AS aqbooksellername,
523                biblio.title AS bibliotitle
524        FROM subscription
525        LEFT JOIN subscriptionhistory ON subscription.subscriptionid=subscriptionhistory.subscriptionid
526        LEFT JOIN aqbudget ON subscription.aqbudgetid=aqbudget.aqbudgetid
527        LEFT JOIN aqbooksellers ON subscription.aqbooksellerid=aqbooksellers.id
528        LEFT JOIN biblio ON biblio.biblionumber=subscription.biblionumber
529        LEFT JOIN branches ON branches.branchcode=subscription.branchcode
530        WHERE subscription.biblionumber = ?
531     );
532 #     if (C4::Context->preference('IndependantBranches') && 
533 #         C4::Context->userenv && 
534 #         C4::Context->userenv->{'flags'} != 1){
535 #        $query.=" AND subscription.branchcode IN ('".C4::Context->userenv->{'branch'}."',\"\")";
536 #     }
537     my $sth = $dbh->prepare($query);
538     $sth->execute($biblionumber);
539     my @res;
540     while ( my $subs = $sth->fetchrow_hashref ) {
541         $subs->{startdate}     = format_date( $subs->{startdate} );
542         $subs->{histstartdate} = format_date( $subs->{histstartdate} );
543         $subs->{histenddate} = format_date( $subs->{histenddate} );
544         $subs->{opacnote}     =~ s/\n/\<br\/\>/g;
545         $subs->{missinglist}  =~ s/\n/\<br\/\>/g;
546         $subs->{recievedlist} =~ s/\n/\<br\/\>/g;
547         $subs->{ "periodicity" . $subs->{periodicity} } = 1;
548         $subs->{ "numberpattern" . $subs->{numberpattern} } = 1;
549         $subs->{ "status" . $subs->{'status'} } = 1;
550         $subs->{'cannotedit'}=(C4::Context->preference('IndependantBranches') && 
551                 C4::Context->userenv && 
552                 C4::Context->userenv->{flags} !=1  && 
553                 C4::Context->userenv->{branch} && $subs->{branchcode} &&
554                 (C4::Context->userenv->{branch} ne $subs->{branchcode}));
555         if ( $subs->{enddate} eq '0000-00-00' ) {
556             $subs->{enddate} = '';
557         }
558         else {
559             $subs->{enddate} = format_date( $subs->{enddate} );
560         }
561         $subs->{'abouttoexpire'}=abouttoexpire($subs->{'subscriptionid'});
562         $subs->{'subscriptionexpired'}=HasSubscriptionExpired($subs->{'subscriptionid'});
563         push @res, $subs;
564     }
565     return \@res;
566 }
567
568 =head2 GetFullSubscriptionsFromBiblionumber
569
570 =over 4
571
572    \@res = GetFullSubscriptionsFromBiblionumber($biblionumber)
573    this function read on serial table.
574
575 =back
576
577 =cut
578
579 sub GetFullSubscriptionsFromBiblionumber {
580     my ($biblionumber) = @_;
581     my $dbh            = C4::Context->dbh;
582     my $query          = qq|
583   SELECT    serial.serialid,
584             serial.serialseq,
585             serial.planneddate, 
586             serial.publisheddate, 
587             serial.status, 
588             serial.notes as notes,
589             year(IF(serial.publisheddate="00-00-0000",serial.planneddate,serial.publisheddate)) as year,
590             aqbudget.bookfundid,aqbooksellers.name as aqbooksellername,
591             biblio.title as bibliotitle,
592             subscription.branchcode AS branchcode,
593             subscription.subscriptionid AS subscriptionid|;
594      if (C4::Context->preference('IndependantBranches') && 
595         C4::Context->userenv && 
596         C4::Context->userenv->{'flags'} != 1 && C4::Context->userenv->{'branch'}){
597       $query.="
598       , ((subscription.branchcode <>\"".C4::Context->userenv->{'branch'}."\") and subscription.branchcode <>\"\" and subscription.branchcode IS NOT NULL) as cannotedit ";
599      }
600       
601      $query.=qq|      
602   FROM      serial 
603   LEFT JOIN subscription ON 
604           (serial.subscriptionid=subscription.subscriptionid)
605   LEFT JOIN aqbudget ON subscription.aqbudgetid=aqbudget.aqbudgetid 
606   LEFT JOIN aqbooksellers on subscription.aqbooksellerid=aqbooksellers.id 
607   LEFT JOIN biblio on biblio.biblionumber=subscription.biblionumber 
608   WHERE     subscription.biblionumber = ? 
609   ORDER BY year DESC,
610           IF(serial.publisheddate="00-00-0000",serial.planneddate,serial.publisheddate) DESC,
611           serial.subscriptionid
612           |;
613     my $sth = $dbh->prepare($query);
614     $sth->execute($biblionumber);
615     return $sth->fetchall_arrayref({});
616 }
617
618 =head2 GetSubscriptions
619
620 =over 4
621
622 @results = GetSubscriptions($title,$ISSN,$biblionumber);
623 this function get all subscriptions which has title like $title,ISSN like $ISSN and biblionumber like $biblionumber.
624 return:
625 a table of hashref. Each hash containt the subscription.
626
627 =back
628
629 =cut
630
631 sub GetSubscriptions {
632     my ( $title, $ISSN, $biblionumber ) = @_;
633     #return unless $title or $ISSN or $biblionumber;
634     my $dbh = C4::Context->dbh;
635     my $sth;
636     if ($biblionumber) {
637         my $query = qq(
638             SELECT subscription.*,biblio.title,biblioitems.issn,biblio.biblionumber
639             FROM   subscription
640             LEFT JOIN biblio ON biblio.biblionumber = subscription.biblionumber
641             LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
642             WHERE biblio.biblionumber=?
643         );
644         $query.=" ORDER BY title";
645         $debug and warn "GetSubscriptions query: $query";
646         $sth = $dbh->prepare($query);
647         $sth->execute($biblionumber);
648     }
649     else {
650         if ( $ISSN and $title ) {
651             my $query = qq|
652                 SELECT subscription.*,biblio.title,biblioitems.issn,biblio.biblionumber        
653                 FROM   subscription
654                 LEFT JOIN biblio ON biblio.biblionumber = subscription.biblionumber
655                 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
656                 WHERE (biblioitems.issn = ? or|. join('and ',map{"biblio.title LIKE \"%$_%\""}split (" ",$title))." )";
657             $query.=" ORDER BY title";
658                 $debug and warn "GetSubscriptions query: $query";
659             $sth = $dbh->prepare($query);
660             $sth->execute( $ISSN );
661         }
662         else {
663             if ($ISSN) {
664                 my $query = qq(
665                     SELECT subscription.*,biblio.title,biblioitems.issn,biblio.biblionumber
666                     FROM   subscription
667                     LEFT JOIN biblio ON biblio.biblionumber = subscription.biblionumber
668                     LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
669                     WHERE biblioitems.issn LIKE ?
670                 );
671                 $query.=" ORDER BY title";
672                         $debug and warn "GetSubscriptions query: $query";
673                 $sth = $dbh->prepare($query);
674                 $sth->execute( "%" . $ISSN . "%" );
675             }
676             else {
677                 my $query = qq(
678                     SELECT subscription.*,biblio.title,biblioitems.issn,biblio.biblionumber
679                     FROM   subscription
680                     LEFT JOIN biblio ON biblio.biblionumber = subscription.biblionumber
681                     LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
682                     WHERE 1
683                     ).($title?" and ":""). join('and ',map{"biblio.title LIKE \"%$_%\""} split (" ",$title) );
684                 
685                 $query.=" ORDER BY title";
686                         $debug and warn "GetSubscriptions query: $query";
687                 $sth = $dbh->prepare($query);
688                 $sth->execute;
689             }
690         }
691     }
692     my @results;
693     my $previoustitle = "";
694     my $odd           = 1;
695     while ( my $line = $sth->fetchrow_hashref ) {
696         if ( $previoustitle eq $line->{title} ) {
697             $line->{title}  = "";
698             $line->{issn}   = "";
699         }
700         else {
701             $previoustitle = $line->{title};
702             $odd           = -$odd;
703         }
704         $line->{toggle} = 1 if $odd == 1;
705         $line->{'cannotedit'}=(C4::Context->preference('IndependantBranches') && 
706                 C4::Context->userenv && 
707                 C4::Context->userenv->{flags} !=1  && 
708                 C4::Context->userenv->{branch} && $line->{branchcode} &&
709                 (C4::Context->userenv->{branch} ne $line->{branchcode}));
710         push @results, $line;
711     }
712     return @results;
713 }
714
715 =head2 GetSerials
716
717 =over 4
718
719 ($totalissues,@serials) = GetSerials($subscriptionid);
720 this function get every serial not arrived for a given subscription
721 as well as the number of issues registered in the database (all types)
722 this number is used to see if a subscription can be deleted (=it must have only 1 issue)
723
724 FIXME: We should return \@serials.
725
726 =back
727
728 =cut
729
730 sub GetSerials {
731     my ($subscriptionid,$count) = @_;
732     my $dbh = C4::Context->dbh;
733
734     # status = 2 is "arrived"
735     my $counter = 0;
736     $count=5 unless ($count);
737     my @serials;
738     my $query =
739       "SELECT serialid,serialseq, status, publisheddate, planneddate,notes, routingnotes
740                         FROM   serial
741                         WHERE  subscriptionid = ? AND status NOT IN (2,4,5) 
742                         ORDER BY IF(publisheddate<>'0000-00-00',publisheddate,planneddate) DESC";
743     my $sth = $dbh->prepare($query);
744     $sth->execute($subscriptionid);
745     while ( my $line = $sth->fetchrow_hashref ) {
746         $line->{ "status" . $line->{status} } =
747           1;    # fills a "statusX" value, used for template status select list
748         $line->{"publisheddate"} = format_date( $line->{"publisheddate"} );
749         $line->{"planneddate"}   = format_date( $line->{"planneddate"} );
750         push @serials, $line;
751     }
752     # OK, now add the last 5 issues arrives/missing
753     $query =
754       "SELECT   serialid,serialseq, status, planneddate, publisheddate,notes, routingnotes
755        FROM     serial
756        WHERE    subscriptionid = ?
757        AND      (status in (2,4,5))
758        ORDER BY IF(publisheddate<>'0000-00-00',publisheddate,planneddate) DESC
759       ";
760     $sth = $dbh->prepare($query);
761     $sth->execute($subscriptionid);
762     while ( ( my $line = $sth->fetchrow_hashref ) && $counter < $count ) {
763         $counter++;
764         $line->{ "status" . $line->{status} } =
765           1;    # fills a "statusX" value, used for template status select list
766         $line->{"planneddate"}   = format_date( $line->{"planneddate"} );
767         $line->{"publisheddate"} = format_date( $line->{"publisheddate"} );
768         push @serials, $line;
769     }
770
771     $query = "SELECT count(*) FROM serial WHERE subscriptionid=?";
772     $sth = $dbh->prepare($query);
773     $sth->execute($subscriptionid);
774     my ($totalissues) = $sth->fetchrow;
775     return ( $totalissues, @serials );
776 }
777
778 =head2 GetSerials2
779
780 =over 4
781
782 ($totalissues,@serials) = GetSerials2($subscriptionid,$status);
783 this function get every serial waited for a given subscription
784 as well as the number of issues registered in the database (all types)
785 this number is used to see if a subscription can be deleted (=it must have only 1 issue)
786
787 =back
788
789 =cut
790 sub GetSerials2 {
791     my ($subscription,$status) = @_;
792     my $dbh = C4::Context->dbh;
793     my $query = qq|
794                  SELECT   serialid,serialseq, status, planneddate, publisheddate,notes, routingnotes
795                  FROM     serial 
796                  WHERE    subscriptionid=$subscription AND status IN ($status)
797                  ORDER BY publisheddate,serialid DESC
798                     |;
799         $debug and warn "GetSerials2 query: $query";
800     my $sth=$dbh->prepare($query);
801     $sth->execute;
802     my @serials;
803     while(my $line = $sth->fetchrow_hashref) {
804         $line->{"status".$line->{status}} = 1; # fills a "statusX" value, used for template status select list
805         $line->{"planneddate"} = format_date($line->{"planneddate"});
806         $line->{"publisheddate"} = format_date($line->{"publisheddate"});
807         push @serials,$line;
808     }
809     my ($totalissues) = scalar(@serials);
810     return ($totalissues,@serials);
811 }
812
813 =head2 GetLatestSerials
814
815 =over 4
816
817 \@serials = GetLatestSerials($subscriptionid,$limit)
818 get the $limit's latest serials arrived or missing for a given subscription
819 return :
820 a ref to a table which it containts all of the latest serials stored into a hash.
821
822 =back
823
824 =cut
825
826 sub GetLatestSerials {
827     my ( $subscriptionid, $limit ) = @_;
828     my $dbh = C4::Context->dbh;
829
830     # status = 2 is "arrived"
831     my $strsth = "SELECT   serialid,serialseq, status, planneddate, notes
832                         FROM     serial
833                         WHERE    subscriptionid = ?
834                         AND      (status =2 or status=4)
835                         ORDER BY planneddate DESC LIMIT 0,$limit
836                 ";
837     my $sth = $dbh->prepare($strsth);
838     $sth->execute($subscriptionid);
839     my @serials;
840     while ( my $line = $sth->fetchrow_hashref ) {
841         $line->{ "status" . $line->{status} } =
842           1;    # fills a "statusX" value, used for template status select list
843         $line->{"planneddate"} = format_date( $line->{"planneddate"} );
844         push @serials, $line;
845     }
846
847     #     my $query = qq|
848     #         SELECT count(*)
849     #         FROM   serial
850     #         WHERE  subscriptionid=?
851     #     |;
852     #     $sth=$dbh->prepare($query);
853     #     $sth->execute($subscriptionid);
854     #     my ($totalissues) = $sth->fetchrow;
855     return \@serials;
856 }
857
858 =head2 GetDistributedTo
859
860 =over 4
861
862 $distributedto=GetDistributedTo($subscriptionid)
863 This function select the old previous value of distributedto in the database.
864
865 =back
866
867 =cut
868
869 sub GetDistributedTo {
870     my $dbh = C4::Context->dbh;
871     my $distributedto;
872     my $subscriptionid = @_;
873     my $query = "SELECT distributedto FROM subscription WHERE subscriptionid=?";
874     my $sth   = $dbh->prepare($query);
875     $sth->execute($subscriptionid);
876     return ($distributedto) = $sth->fetchrow;
877 }
878
879 =head2 GetNextSeq
880
881 =over 4
882
883 GetNextSeq($val)
884 $val is a hashref containing all the attributes of the table 'subscription'
885 This function get the next issue for the subscription given on input arg
886 return:
887 all the input params updated.
888
889 =back
890
891 =cut
892
893 # sub GetNextSeq {
894 #     my ($val) =@_;
895 #     my ($calculated,$newlastvalue1,$newlastvalue2,$newlastvalue3,$newinnerloop1,$newinnerloop2,$newinnerloop3);
896 #     $calculated = $val->{numberingmethod};
897 # # calculate the (expected) value of the next issue recieved.
898 #     $newlastvalue1 = $val->{lastvalue1};
899 # # check if we have to increase the new value.
900 #     $newinnerloop1 = $val->{innerloop1}+1;
901 #     $newinnerloop1=0 if ($newinnerloop1 >= $val->{every1});
902 #     $newlastvalue1 += $val->{add1} if ($newinnerloop1<1); # <1 to be true when 0 or empty.
903 #     $newlastvalue1=$val->{setto1} if ($newlastvalue1>$val->{whenmorethan1}); # reset counter if needed.
904 #     $calculated =~ s/\{X\}/$newlastvalue1/g;
905 #
906 #     $newlastvalue2 = $val->{lastvalue2};
907 # # check if we have to increase the new value.
908 #     $newinnerloop2 = $val->{innerloop2}+1;
909 #     $newinnerloop2=0 if ($newinnerloop2 >= $val->{every2});
910 #     $newlastvalue2 += $val->{add2} if ($newinnerloop2<1); # <1 to be true when 0 or empty.
911 #     $newlastvalue2=$val->{setto2} if ($newlastvalue2>$val->{whenmorethan2}); # reset counter if needed.
912 #     $calculated =~ s/\{Y\}/$newlastvalue2/g;
913 #
914 #     $newlastvalue3 = $val->{lastvalue3};
915 # # check if we have to increase the new value.
916 #     $newinnerloop3 = $val->{innerloop3}+1;
917 #     $newinnerloop3=0 if ($newinnerloop3 >= $val->{every3});
918 #     $newlastvalue3 += $val->{add3} if ($newinnerloop3<1); # <1 to be true when 0 or empty.
919 #     $newlastvalue3=$val->{setto3} if ($newlastvalue3>$val->{whenmorethan3}); # reset counter if needed.
920 #     $calculated =~ s/\{Z\}/$newlastvalue3/g;
921 #     return ($calculated,$newlastvalue1,$newlastvalue2,$newlastvalue3,$newinnerloop1,$newinnerloop2,$newinnerloop3);
922 # }
923
924 sub GetNextSeq {
925     my ($val) = @_;
926     my (
927         $calculated,    $newlastvalue1, $newlastvalue2, $newlastvalue3,
928         $newinnerloop1, $newinnerloop2, $newinnerloop3
929     );
930     my $pattern = $val->{numberpattern};
931     my @seasons = ( 'nothing', 'Winter', 'Spring', 'Summer', 'Autumn' );
932     my @southern_seasons = ( '', 'Summer', 'Autumn', 'Winter', 'Spring' );
933     $calculated    = $val->{numberingmethod};
934     $newlastvalue1 = $val->{lastvalue1};
935     $newlastvalue2 = $val->{lastvalue2};
936     $newlastvalue3 = $val->{lastvalue3};
937   $newlastvalue1 = $val->{lastvalue1};
938   # check if we have to increase the new value.
939   $newinnerloop1 = $val->{innerloop1} + 1;
940   $newinnerloop1=0 if ($newinnerloop1 >= $val->{every1});
941   $newlastvalue1 += $val->{add1} if ($newinnerloop1<1); # <1 to be true when 0 or empty.
942   $newlastvalue1=$val->{setto1} if ($newlastvalue1>$val->{whenmorethan1}); # reset counter if needed.
943   $calculated =~ s/\{X\}/$newlastvalue1/g;
944   
945   $newlastvalue2 = $val->{lastvalue2};
946   # check if we have to increase the new value.
947   $newinnerloop2 = $val->{innerloop2} + 1;
948   $newinnerloop2=0 if ($newinnerloop2 >= $val->{every2});
949   $newlastvalue2 += $val->{add2} if ($newinnerloop2<1); # <1 to be true when 0 or empty.
950   $newlastvalue2=$val->{setto2} if ($newlastvalue2>$val->{whenmorethan2}); # reset counter if needed.
951   if ( $pattern == 6 ) {
952     if ( $val->{hemisphere} == 2 ) {
953        my $newlastvalue2seq = $southern_seasons[$newlastvalue2];
954        $calculated =~ s/\{Y\}/$newlastvalue2seq/g;
955     }
956     else {
957        my $newlastvalue2seq = $seasons[$newlastvalue2];
958        $calculated =~ s/\{Y\}/$newlastvalue2seq/g;
959     }
960   }
961   else {
962     $calculated =~ s/\{Y\}/$newlastvalue2/g;
963   }
964   
965   
966   $newlastvalue3 = $val->{lastvalue3};
967   # check if we have to increase the new value.
968   $newinnerloop3 = $val->{innerloop3} + 1;
969   $newinnerloop3=0 if ($newinnerloop3 >= $val->{every3});
970   $newlastvalue3 += $val->{add3} if ($newinnerloop3<1); # <1 to be true when 0 or empty.
971   $newlastvalue3=$val->{setto3} if ($newlastvalue3>$val->{whenmorethan3}); # reset counter if needed.
972   $calculated =~ s/\{Z\}/$newlastvalue3/g;
973     
974   return ( $calculated, $newlastvalue1, $newlastvalue2, $newlastvalue3 ,
975            $newinnerloop1, $newinnerloop2, $newinnerloop3);
976 }
977
978 =head2 GetSeq
979
980 =over 4
981
982 $calculated = GetSeq($val)
983 $val is a hashref containing all the attributes of the table 'subscription'
984 this function transforms {X},{Y},{Z} to 150,0,0 for example.
985 return:
986 the sequence in integer format
987
988 =back
989
990 =cut
991
992 sub GetSeq {
993     my ($val)      = @_;
994     my $pattern = $val->{numberpattern};
995     my @seasons = ( 'nothing', 'Winter', 'Spring', 'Summer', 'Autumn' );
996     my @southern_seasons = ( '', 'Summer', 'Autumn', 'Winter', 'Spring' );
997     my $calculated = $val->{numberingmethod};
998     my $x          = $val->{'lastvalue1'};
999     $calculated =~ s/\{X\}/$x/g;
1000     my $newlastvalue2 = $val->{'lastvalue2'};
1001     if ( $pattern == 6 ) {
1002         if ( $val->{hemisphere} == 2 ) {
1003             my $newlastvalue2seq = $southern_seasons[$newlastvalue2];
1004             $calculated =~ s/\{Y\}/$newlastvalue2seq/g;
1005         }
1006         else {
1007             my $newlastvalue2seq = $seasons[$newlastvalue2];
1008             $calculated =~ s/\{Y\}/$newlastvalue2seq/g;
1009         }
1010     }
1011     else {
1012         $calculated =~ s/\{Y\}/$newlastvalue2/g;
1013     }
1014     my $z = $val->{'lastvalue3'};
1015     $calculated =~ s/\{Z\}/$z/g;
1016     return $calculated;
1017 }
1018
1019 =head2 GetExpirationDate
1020
1021 $sensddate = GetExpirationDate($subscriptionid)
1022
1023 this function return the expiration date for a subscription given on input args.
1024
1025 return
1026 the enddate
1027
1028 =cut
1029
1030 sub GetExpirationDate {
1031     my ($subscriptionid) = @_;
1032     my $dbh              = C4::Context->dbh;
1033     my $subscription     = GetSubscription($subscriptionid);
1034     my $enddate          = $subscription->{startdate};
1035
1036 # we don't do the same test if the subscription is based on X numbers or on X weeks/months
1037     if (($subscription->{periodicity} % 16) >0){
1038       if ( $subscription->{numberlength} ) {
1039           #calculate the date of the last issue.
1040           my $length = $subscription->{numberlength};
1041           for ( my $i = 1 ; $i <= $length ; $i++ ) {
1042               $enddate = GetNextDate( $enddate, $subscription );
1043           }
1044       }
1045       elsif ( $subscription->{monthlength} ){
1046           my @date=split (/-/,$subscription->{startdate});
1047           my @enddate = Add_Delta_YM($date[0],$date[1],$date[2],0,$subscription->{monthlength});
1048           $enddate=sprintf("%04d-%02d-%02d",$enddate[0],$enddate[1],$enddate[2]);
1049       } elsif ( $subscription->{weeklength} ){
1050           my @date=split (/-/,$subscription->{startdate});
1051           my @enddate = Add_Delta_Days($date[0],$date[1],$date[2],$subscription->{weeklength}*7);
1052           $enddate=sprintf("%04d-%02d-%02d",$enddate[0],$enddate[1],$enddate[2]);
1053       }
1054       return $enddate;
1055     } else {
1056       return 0;  
1057     }  
1058 }
1059
1060 =head2 CountSubscriptionFromBiblionumber
1061
1062 =over 4
1063
1064 $subscriptionsnumber = CountSubscriptionFromBiblionumber($biblionumber)
1065 this count the number of subscription for a biblionumber given.
1066 return :
1067 the number of subscriptions with biblionumber given on input arg.
1068
1069 =back
1070
1071 =cut
1072
1073 sub CountSubscriptionFromBiblionumber {
1074     my ($biblionumber) = @_;
1075     my $dbh = C4::Context->dbh;
1076     my $query = "SELECT count(*) FROM subscription WHERE biblionumber=?";
1077     my $sth   = $dbh->prepare($query);
1078     $sth->execute($biblionumber);
1079     my $subscriptionsnumber = $sth->fetchrow;
1080     return $subscriptionsnumber;
1081 }
1082
1083 =head2 ModSubscriptionHistory
1084
1085 =over 4
1086
1087 ModSubscriptionHistory($subscriptionid,$histstartdate,$enddate,$recievedlist,$missinglist,$opacnote,$librariannote);
1088
1089 this function modify the history of a subscription. Put your new values on input arg.
1090
1091 =back
1092
1093 =cut
1094
1095 sub ModSubscriptionHistory {
1096     my (
1097         $subscriptionid, $histstartdate, $enddate, $recievedlist,
1098         $missinglist,    $opacnote,      $librariannote
1099     ) = @_;
1100     my $dbh   = C4::Context->dbh;
1101     my $query = "UPDATE subscriptionhistory 
1102                     SET histstartdate=?,enddate=?,recievedlist=?,missinglist=?,opacnote=?,librariannote=?
1103                     WHERE subscriptionid=?
1104                 ";
1105     my $sth = $dbh->prepare($query);
1106     $recievedlist =~ s/^; //;
1107     $missinglist  =~ s/^; //;
1108     $opacnote     =~ s/^; //;
1109     $sth->execute(
1110         $histstartdate, $enddate,       $recievedlist, $missinglist,
1111         $opacnote,      $librariannote, $subscriptionid
1112     );
1113     return $sth->rows;
1114 }
1115
1116 =head2 ModSerialStatus
1117
1118 =over 4
1119
1120 ModSerialStatus($serialid,$serialseq, $planneddate,$publisheddate,$status,$notes)
1121
1122 This function modify the serial status. Serial status is a number.(eg 2 is "arrived")
1123 Note : if we change from "waited" to something else,then we will have to create a new "waited" entry
1124
1125 =back
1126
1127 =cut
1128
1129 sub ModSerialStatus {
1130     my ( $serialid, $serialseq,  $planneddate,$publisheddate, $status, $notes )
1131       = @_;
1132
1133     #It is a usual serial
1134     # 1st, get previous status :
1135     my $dbh   = C4::Context->dbh;
1136     my $query = "SELECT subscriptionid,status FROM serial WHERE  serialid=?";
1137     my $sth   = $dbh->prepare($query);
1138     $sth->execute($serialid);
1139     my ( $subscriptionid, $oldstatus ) = $sth->fetchrow;
1140
1141     # change status & update subscriptionhistory
1142     my $val;
1143     if ( $status eq 6 ) {
1144         DelIssue( {'serialid'=>$serialid, 'subscriptionid'=>$subscriptionid,'serialseq'=>$serialseq} );
1145     }
1146     else {
1147         my $query =
1148 "UPDATE serial SET serialseq=?,publisheddate=?,planneddate=?,status=?,notes=? WHERE  serialid = ?";
1149         $sth = $dbh->prepare($query);
1150         $sth->execute( $serialseq, $publisheddate, $planneddate, $status,
1151             $notes, $serialid );
1152         $query = "SELECT * FROM   subscription WHERE  subscriptionid = ?";
1153         $sth = $dbh->prepare($query);
1154         $sth->execute($subscriptionid);
1155         my $val = $sth->fetchrow_hashref;
1156         unless ( $val->{manualhistory} ) {
1157             $query =
1158 "SELECT missinglist,recievedlist FROM subscriptionhistory WHERE  subscriptionid=?";
1159             $sth = $dbh->prepare($query);
1160             $sth->execute($subscriptionid);
1161             my ( $missinglist, $recievedlist ) = $sth->fetchrow;
1162             if ( $status eq 2 ) {
1163
1164                 $recievedlist .= "; $serialseq"
1165                   unless ( index( "$recievedlist", "$serialseq" ) >= 0 );
1166             }
1167
1168 #         warn "missinglist : $missinglist serialseq :$serialseq, ".index("$missinglist","$serialseq");
1169             $missinglist .= "; $serialseq"
1170               if ( $status eq 4
1171                 and not index( "$missinglist", "$serialseq" ) >= 0 );
1172             $missinglist .= "; not issued $serialseq"
1173               if ( $status eq 5
1174                 and index( "$missinglist", "$serialseq" ) >= 0 );
1175             $query =
1176 "UPDATE subscriptionhistory SET recievedlist=?, missinglist=? WHERE  subscriptionid=?";
1177             $sth = $dbh->prepare($query);
1178             $recievedlist =~ s/^; //;
1179             $missinglist  =~ s/^; //;
1180             $sth->execute( $recievedlist, $missinglist, $subscriptionid );
1181         }
1182     }
1183
1184     # create new waited entry if needed (ie : was a "waited" and has changed)
1185     if ( $oldstatus eq 1 && $status ne 1 ) {
1186         my $query = "SELECT * FROM   subscription WHERE  subscriptionid = ?";
1187         $sth = $dbh->prepare($query);
1188         $sth->execute($subscriptionid);
1189         my $val = $sth->fetchrow_hashref;
1190
1191         # next issue number
1192 #     warn "Next Seq";    
1193         my (
1194             $newserialseq,  $newlastvalue1, $newlastvalue2, $newlastvalue3,
1195             $newinnerloop1, $newinnerloop2, $newinnerloop3
1196         ) = GetNextSeq($val);
1197 #     warn "Next Seq End";    
1198
1199         # next date (calculated from actual date & frequency parameters)
1200 #         warn "publisheddate :$publisheddate ";
1201         my $nextpublisheddate = GetNextDate( $publisheddate, $val );
1202         NewIssue( $newserialseq, $subscriptionid, $val->{'biblionumber'},
1203             1, $nextpublisheddate, $nextpublisheddate );
1204         $query =
1205 "UPDATE subscription SET lastvalue1=?, lastvalue2=?, lastvalue3=?, innerloop1=?, innerloop2=?, innerloop3=?
1206                     WHERE  subscriptionid = ?";
1207         $sth = $dbh->prepare($query);
1208         $sth->execute(
1209             $newlastvalue1, $newlastvalue2, $newlastvalue3, $newinnerloop1,
1210             $newinnerloop2, $newinnerloop3, $subscriptionid
1211         );
1212
1213 # check if an alert must be sent... (= a letter is defined & status became "arrived"
1214         if ( $val->{letter} && $status eq 2 && $oldstatus ne 2 ) {
1215             SendAlerts( 'issue', $val->{subscriptionid}, $val->{letter} );
1216         }
1217     }
1218 }
1219
1220 =head2 GetNextExpected
1221
1222 =over 4
1223
1224 $nextexpected = GetNextExpected($subscriptionid)
1225
1226 Get the planneddate for the current expected issue of the subscription.
1227
1228 returns a hashref:
1229
1230 $nextexepected = {
1231     serialid => int
1232     planneddate => C4::Dates object
1233     }
1234
1235 =back
1236
1237 =cut
1238
1239 sub GetNextExpected($) {
1240     my ($subscriptionid) = @_;
1241     my $dbh = C4::Context->dbh;
1242     my $sth = $dbh->prepare('SELECT serialid, planneddate FROM serial WHERE subscriptionid=? AND status=?');
1243     # Each subscription has only one 'expected' issue, with serial.status==1.
1244     $sth->execute( $subscriptionid, 1 );
1245     my ( $nextissue ) = $sth->fetchrow_hashref;
1246     if(not $nextissue){
1247          $sth = $dbh->prepare('SELECT serialid,planneddate FROM serial WHERE subscriptionid  = ? ORDER BY planneddate DESC LIMIT 1');
1248          $sth->execute( $subscriptionid );  
1249          $nextissue = $sth->fetchrow_hashref;       
1250     }
1251     $nextissue->{planneddate} = C4::Dates->new($nextissue->{planneddate},'iso');
1252     return $nextissue;
1253     
1254 }
1255 =head2 ModNextExpected
1256
1257 =over 4
1258
1259 ModNextExpected($subscriptionid,$date)
1260
1261 Update the planneddate for the current expected issue of the subscription.
1262 This will modify all future prediction results.  
1263
1264 C<$date> is a C4::Dates object.
1265
1266 =back
1267
1268 =cut
1269
1270 sub ModNextExpected($$) {
1271     my ($subscriptionid,$date) = @_;
1272     my $dbh = C4::Context->dbh;
1273     #FIXME: Would expect to only set planneddate, but we set both on new issue creation, so updating it here
1274     my $sth = $dbh->prepare('UPDATE serial SET planneddate=?,publisheddate=? WHERE subscriptionid=? AND status=?');
1275     # Each subscription has only one 'expected' issue, with serial.status==1.
1276     $sth->execute( $date->output('iso'),$date->output('iso'), $subscriptionid, 1);
1277     return 0;
1278
1279 }
1280
1281 =head2 ModSubscription
1282
1283 =over 4
1284
1285 this function modify a subscription. Put all new values on input args.
1286
1287 =back
1288
1289 =cut
1290
1291 sub ModSubscription {
1292     my (
1293         $auser,           $branchcode,   $aqbooksellerid, $cost,
1294         $aqbudgetid,      $startdate,    $periodicity,    $firstacquidate,
1295         $dow,             $irregularity, $numberpattern,  $numberlength,
1296         $weeklength,      $monthlength,  $add1,           $every1,
1297         $whenmorethan1,   $setto1,       $lastvalue1,     $innerloop1,
1298         $add2,            $every2,       $whenmorethan2,  $setto2,
1299         $lastvalue2,      $innerloop2,   $add3,           $every3,
1300         $whenmorethan3,   $setto3,       $lastvalue3,     $innerloop3,
1301         $numberingmethod, $status,       $biblionumber,   $callnumber,
1302         $notes,           $letter,       $hemisphere,     $manualhistory,
1303         $internalnotes,   $serialsadditems,$subscriptionid,
1304         $staffdisplaycount,$opacdisplaycount
1305     ) = @_;
1306 #     warn $irregularity;
1307     my $dbh   = C4::Context->dbh;
1308     my $query = "UPDATE subscription
1309                     SET librarian=?, branchcode=?,aqbooksellerid=?,cost=?,aqbudgetid=?,startdate=?,
1310                         periodicity=?,firstacquidate=?,dow=?,irregularity=?, numberpattern=?, numberlength=?,weeklength=?,monthlength=?,
1311                         add1=?,every1=?,whenmorethan1=?,setto1=?,lastvalue1=?,innerloop1=?,
1312                         add2=?,every2=?,whenmorethan2=?,setto2=?,lastvalue2=?,innerloop2=?,
1313                         add3=?,every3=?,whenmorethan3=?,setto3=?,lastvalue3=?,innerloop3=?,
1314                         numberingmethod=?, status=?, biblionumber=?, callnumber=?, notes=?, letter=?, hemisphere=?,manualhistory=?,internalnotes=?,serialsadditems=?,staffdisplaycount = ?,opacdisplaycount = ?
1315                     WHERE subscriptionid = ?";
1316      #warn "query :".$query;
1317     my $sth = $dbh->prepare($query);
1318     $sth->execute(
1319         $auser,           $branchcode,   $aqbooksellerid, $cost,
1320         $aqbudgetid,      $startdate,    $periodicity,    $firstacquidate,
1321         $dow,             "$irregularity", $numberpattern,  $numberlength,
1322         $weeklength,      $monthlength,  $add1,           $every1,
1323         $whenmorethan1,   $setto1,       $lastvalue1,     $innerloop1,
1324         $add2,            $every2,       $whenmorethan2,  $setto2,
1325         $lastvalue2,      $innerloop2,   $add3,           $every3,
1326         $whenmorethan3,   $setto3,       $lastvalue3,     $innerloop3,
1327         $numberingmethod, $status,       $biblionumber,   $callnumber,
1328         $notes,           $letter,       $hemisphere,     ($manualhistory?$manualhistory:0),
1329         $internalnotes,   $serialsadditems,
1330         $staffdisplaycount, $opacdisplaycount, $subscriptionid
1331     );
1332     my $rows=$sth->rows;
1333     $sth->finish;
1334     
1335     logaction("SERIAL", "MODIFY", $subscriptionid, "") if C4::Context->preference("SubscriptionLog");
1336     return $rows;
1337 }
1338
1339 =head2 NewSubscription
1340
1341 =over 4
1342
1343 $subscriptionid = &NewSubscription($auser,branchcode,$aqbooksellerid,$cost,$aqbudgetid,$biblionumber,
1344     $startdate,$periodicity,$dow,$numberlength,$weeklength,$monthlength,
1345     $add1,$every1,$whenmorethan1,$setto1,$lastvalue1,$innerloop1,
1346     $add2,$every2,$whenmorethan2,$setto2,$lastvalue2,$innerloop2,
1347     $add3,$every3,$whenmorethan3,$setto3,$lastvalue3,$innerloop3,
1348     $numberingmethod, $status, $notes, $serialsadditems, graceperiod)
1349
1350 Create a new subscription with value given on input args.
1351
1352 return :
1353 the id of this new subscription
1354
1355 =back
1356
1357 =cut
1358
1359 sub NewSubscription {
1360     my (
1361         $auser,         $branchcode,   $aqbooksellerid,  $cost,
1362         $aqbudgetid,    $biblionumber, $startdate,       $periodicity,
1363         $dow,           $numberlength, $weeklength,      $monthlength,
1364         $add1,          $every1,       $whenmorethan1,   $setto1,
1365         $lastvalue1,    $innerloop1,   $add2,            $every2,
1366         $whenmorethan2, $setto2,       $lastvalue2,      $innerloop2,
1367         $add3,          $every3,       $whenmorethan3,   $setto3,
1368         $lastvalue3,    $innerloop3,   $numberingmethod, $status,
1369         $notes,         $letter,       $firstacquidate,  $irregularity,
1370         $numberpattern, $callnumber,   $hemisphere,      $manualhistory,
1371         $internalnotes, $serialsadditems, $staffdisplaycount, $opacdisplaycount,
1372         $graceperiod
1373     ) = @_;
1374     my $dbh = C4::Context->dbh;
1375
1376     #save subscription (insert into database)
1377     my $query = qq|
1378         INSERT INTO subscription
1379             (librarian,branchcode,aqbooksellerid,cost,aqbudgetid,biblionumber,
1380             startdate,periodicity,dow,numberlength,weeklength,monthlength,
1381             add1,every1,whenmorethan1,setto1,lastvalue1,innerloop1,
1382             add2,every2,whenmorethan2,setto2,lastvalue2,innerloop2,
1383             add3,every3,whenmorethan3,setto3,lastvalue3,innerloop3,
1384             numberingmethod, status, notes, letter,firstacquidate,irregularity,
1385             numberpattern, callnumber, hemisphere,manualhistory,internalnotes,serialsadditems,
1386             staffdisplaycount,opacdisplaycount,graceperiod)
1387         VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
1388         |;
1389     my $sth = $dbh->prepare($query);
1390     $sth->execute(
1391         $auser,                         $branchcode,
1392         $aqbooksellerid,                $cost,
1393         $aqbudgetid,                    $biblionumber,
1394         format_date_in_iso($startdate), $periodicity,
1395         $dow,                           $numberlength,
1396         $weeklength,                    $monthlength,
1397         $add1,                          $every1,
1398         $whenmorethan1,                 $setto1,
1399         $lastvalue1,                    $innerloop1,
1400         $add2,                          $every2,
1401         $whenmorethan2,                 $setto2,
1402         $lastvalue2,                    $innerloop2,
1403         $add3,                          $every3,
1404         $whenmorethan3,                 $setto3,
1405         $lastvalue3,                    $innerloop3,
1406         $numberingmethod,               "$status",
1407         $notes,                         $letter,
1408         format_date_in_iso($firstacquidate),                $irregularity,
1409         $numberpattern,                 $callnumber,
1410         $hemisphere,                    $manualhistory,
1411         $internalnotes,                 $serialsadditems,
1412                 $staffdisplaycount,                             $opacdisplaycount,
1413         $graceperiod,
1414     );
1415
1416     #then create the 1st waited number
1417     my $subscriptionid = $dbh->{'mysql_insertid'};
1418     $query             = qq(
1419         INSERT INTO subscriptionhistory
1420             (biblionumber, subscriptionid, histstartdate,  opacnote, librariannote)
1421         VALUES (?,?,?,?,?)
1422         );
1423     $sth = $dbh->prepare($query);
1424     $sth->execute( $biblionumber, $subscriptionid,
1425         format_date_in_iso($startdate),
1426         $notes,$internalnotes );
1427
1428    # reread subscription to get a hash (for calculation of the 1st issue number)
1429     $query = qq(
1430         SELECT *
1431         FROM   subscription
1432         WHERE  subscriptionid = ?
1433     );
1434     $sth = $dbh->prepare($query);
1435     $sth->execute($subscriptionid);
1436     my $val = $sth->fetchrow_hashref;
1437
1438     # calculate issue number
1439     my $serialseq = GetSeq($val);
1440     $query     = qq|
1441         INSERT INTO serial
1442             (serialseq,subscriptionid,biblionumber,status, planneddate, publisheddate)
1443         VALUES (?,?,?,?,?,?)
1444     |;
1445     $sth = $dbh->prepare($query);
1446     $sth->execute(
1447         "$serialseq", $subscriptionid, $biblionumber, 1,
1448         format_date_in_iso($firstacquidate),
1449         format_date_in_iso($firstacquidate)
1450     );
1451     
1452     logaction("SERIAL", "ADD", $subscriptionid, "") if C4::Context->preference("SubscriptionLog");
1453     
1454 #set serial flag on biblio if not already set.
1455     my ($null, ($bib)) = GetBiblio($biblionumber);
1456     if( ! $bib->{'serial'} ) {
1457         my $record = GetMarcBiblio($biblionumber);
1458         my ($tag,$subf) = GetMarcFromKohaField('biblio.serial',$bib->{'frameworkcode'});
1459         if($tag) {
1460             eval {
1461             $record->field($tag)->update( $subf => 1 );
1462             };
1463         }
1464         ModBiblio($record,$biblionumber,$bib->{'frameworkcode'});
1465     }    
1466     return $subscriptionid;
1467 }
1468
1469 =head2 ReNewSubscription
1470
1471 =over 4
1472
1473 ReNewSubscription($subscriptionid,$user,$startdate,$numberlength,$weeklength,$monthlength,$note)
1474
1475 this function renew a subscription with values given on input args.
1476
1477 =back
1478
1479 =cut
1480
1481 sub ReNewSubscription {
1482     my ( $subscriptionid, $user, $startdate, $numberlength, $weeklength,
1483         $monthlength, $note )
1484       = @_;
1485     my $dbh          = C4::Context->dbh;
1486     my $subscription = GetSubscription($subscriptionid);
1487      my $query        = qq|
1488          SELECT *
1489          FROM   biblio 
1490          LEFT JOIN biblioitems ON biblio.biblionumber=biblioitems.biblionumber
1491          WHERE    biblio.biblionumber=?
1492      |;
1493      my $sth = $dbh->prepare($query);
1494      $sth->execute( $subscription->{biblionumber} );
1495      my $biblio = $sth->fetchrow_hashref;
1496      if (C4::Context->preference("RenewSerialAddsSuggestion")){
1497         NewSuggestion(
1498             $user,             $subscription->{bibliotitle},
1499             $biblio->{author}, $biblio->{publishercode},
1500             $biblio->{note},   '',
1501             '',                '',
1502             '',                '',
1503             $subscription->{biblionumber}
1504         );
1505     }
1506
1507     # renew subscription
1508     $query = qq|
1509         UPDATE subscription
1510         SET    startdate=?,numberlength=?,weeklength=?,monthlength=?
1511         WHERE  subscriptionid=?
1512     |;
1513     $sth = $dbh->prepare($query);
1514     $sth->execute( format_date_in_iso($startdate),
1515         $numberlength, $weeklength, $monthlength, $subscriptionid );
1516         
1517     logaction("SERIAL", "RENEW", $subscriptionid, "") if C4::Context->preference("SubscriptionLog");
1518 }
1519
1520 =head2 NewIssue
1521
1522 =over 4
1523
1524 NewIssue($serialseq,$subscriptionid,$biblionumber,$status, $planneddate, $publisheddate,  $notes)
1525
1526 Create a new issue stored on the database.
1527 Note : we have to update the recievedlist and missinglist on subscriptionhistory for this subscription.
1528
1529 =back
1530
1531 =cut
1532
1533 sub NewIssue {
1534     my ( $serialseq, $subscriptionid, $biblionumber, $status, 
1535         $planneddate, $publisheddate, $notes )
1536       = @_;
1537     ### FIXME biblionumber CAN be provided by subscriptionid. So Do we STILL NEED IT ?
1538     
1539     my $dbh   = C4::Context->dbh;
1540     my $query = qq|
1541         INSERT INTO serial
1542             (serialseq,subscriptionid,biblionumber,status,publisheddate,planneddate,notes)
1543         VALUES (?,?,?,?,?,?,?)
1544     |;
1545     my $sth = $dbh->prepare($query);
1546     $sth->execute( $serialseq, $subscriptionid, $biblionumber, $status,
1547         $publisheddate, $planneddate,$notes );
1548     my $serialid=$dbh->{'mysql_insertid'};
1549     $query = qq|
1550         SELECT missinglist,recievedlist
1551         FROM   subscriptionhistory
1552         WHERE  subscriptionid=?
1553     |;
1554     $sth = $dbh->prepare($query);
1555     $sth->execute($subscriptionid);
1556     my ( $missinglist, $recievedlist ) = $sth->fetchrow;
1557
1558     if ( $status eq 2 ) {
1559       ### TODO Add a feature that improves recognition and description.
1560       ### As such count (serialseq) i.e. : N18,2(N19),N20
1561       ### Would use substr and index But be careful to previous presence of ()
1562         $recievedlist .= "; $serialseq" unless (index($recievedlist,$serialseq)>0);
1563     }
1564     if ( $status eq 4 ) {
1565         $missinglist .= "; $serialseq" unless (index($missinglist,$serialseq)>0);
1566     }
1567     $query = qq|
1568         UPDATE subscriptionhistory
1569         SET    recievedlist=?, missinglist=?
1570         WHERE  subscriptionid=?
1571     |;
1572     $sth = $dbh->prepare($query);
1573     $recievedlist =~ s/^; //;
1574     $missinglist  =~ s/^; //;
1575     $sth->execute( $recievedlist, $missinglist, $subscriptionid );
1576     return $serialid;
1577 }
1578
1579 =head2 ItemizeSerials
1580
1581 =over 4
1582
1583 ItemizeSerials($serialid, $info);
1584 $info is a hashref containing  barcode branch, itemcallnumber, status, location
1585 $serialid the serialid
1586 return :
1587 1 if the itemize is a succes.
1588 0 and @error else. @error containts the list of errors found.
1589
1590 =back
1591
1592 =cut
1593
1594 sub ItemizeSerials {
1595     my ( $serialid, $info ) = @_;
1596     my $now = POSIX::strftime( "%Y-%m-%d",localtime );
1597
1598     my $dbh   = C4::Context->dbh;
1599     my $query = qq|
1600         SELECT *
1601         FROM   serial
1602         WHERE  serialid=?
1603     |;
1604     my $sth = $dbh->prepare($query);
1605     $sth->execute($serialid);
1606     my $data = $sth->fetchrow_hashref;
1607     if ( C4::Context->preference("RoutingSerials") ) {
1608
1609         # check for existing biblioitem relating to serial issue
1610         my ( $count, @results ) =
1611           GetBiblioItemByBiblioNumber( $data->{'biblionumber'} );
1612         my $bibitemno = 0;
1613         for ( my $i = 0 ; $i < $count ; $i++ ) {
1614             if (  $results[$i]->{'volumeddesc'} eq $data->{'serialseq'} . ' ('
1615                 . $data->{'planneddate'}
1616                 . ')' )
1617             {
1618                 $bibitemno = $results[$i]->{'biblioitemnumber'};
1619                 last;
1620             }
1621         }
1622         if ( $bibitemno == 0 ) {
1623
1624     # warn "need to add new biblioitem so copy last one and make minor changes";
1625             my $sth =
1626               $dbh->prepare(
1627 "SELECT * FROM biblioitems WHERE biblionumber = ? ORDER BY biblioitemnumber DESC"
1628               );
1629             $sth->execute( $data->{'biblionumber'} );
1630             my $biblioitem = $sth->fetchrow_hashref;
1631             $biblioitem->{'volumedate'} =
1632               format_date_in_iso( $data->{planneddate} );
1633             $biblioitem->{'volumeddesc'} =
1634               $data->{serialseq} . ' ('
1635               . format_date( $data->{'planneddate'} ) . ')';
1636             $biblioitem->{'dewey'} = $info->{itemcallnumber};
1637
1638             #FIXME  HDL : I don't understand why you need to call newbiblioitem, as the biblioitem should already be somewhere.
1639             # so I comment it, we can speak of it when you want
1640             # newbiblioitems has been removed from Biblio.pm, as it has a deprecated API now
1641 #             if ( $info->{barcode} )
1642 #             {    # only make biblioitem if we are going to make item also
1643 #                 $bibitemno = newbiblioitem($biblioitem);
1644 #             }
1645         }
1646     }
1647
1648     my $fwk = GetFrameworkCode( $data->{'biblionumber'} );
1649     if ( $info->{barcode} ) {
1650         my @errors;
1651         my $exists = itemdata( $info->{'barcode'} );
1652         push @errors, "barcode_not_unique" if ($exists);
1653         unless ($exists) {
1654             my $marcrecord = MARC::Record->new();
1655             my ( $tag, $subfield ) =
1656               GetMarcFromKohaField( "items.barcode", $fwk );
1657             my $newField =
1658               MARC::Field->new( "$tag", '', '',
1659                 "$subfield" => $info->{barcode} );
1660             $marcrecord->insert_fields_ordered($newField);
1661             if ( $info->{branch} ) {
1662                 my ( $tag, $subfield ) =
1663                   GetMarcFromKohaField( "items.homebranch",
1664                     $fwk );
1665
1666                 #warn "items.homebranch : $tag , $subfield";
1667                 if ( $marcrecord->field($tag) ) {
1668                     $marcrecord->field($tag)
1669                       ->add_subfields( "$subfield" => $info->{branch} );
1670                 }
1671                 else {
1672                     my $newField =
1673                       MARC::Field->new( "$tag", '', '',
1674                         "$subfield" => $info->{branch} );
1675                     $marcrecord->insert_fields_ordered($newField);
1676                 }
1677                 ( $tag, $subfield ) =
1678                   GetMarcFromKohaField( "items.holdingbranch",
1679                     $fwk );
1680
1681                 #warn "items.holdingbranch : $tag , $subfield";
1682                 if ( $marcrecord->field($tag) ) {
1683                     $marcrecord->field($tag)
1684                       ->add_subfields( "$subfield" => $info->{branch} );
1685                 }
1686                 else {
1687                     my $newField =
1688                       MARC::Field->new( "$tag", '', '',
1689                         "$subfield" => $info->{branch} );
1690                     $marcrecord->insert_fields_ordered($newField);
1691                 }
1692             }
1693             if ( $info->{itemcallnumber} ) {
1694                 my ( $tag, $subfield ) =
1695                   GetMarcFromKohaField( "items.itemcallnumber",
1696                     $fwk );
1697
1698                 #warn "items.itemcallnumber : $tag , $subfield";
1699                 if ( $marcrecord->field($tag) ) {
1700                     $marcrecord->field($tag)
1701                       ->add_subfields( "$subfield" => $info->{itemcallnumber} );
1702                 }
1703                 else {
1704                     my $newField =
1705                       MARC::Field->new( "$tag", '', '',
1706                         "$subfield" => $info->{itemcallnumber} );
1707                     $marcrecord->insert_fields_ordered($newField);
1708                 }
1709             }
1710             if ( $info->{notes} ) {
1711                 my ( $tag, $subfield ) =
1712                   GetMarcFromKohaField( "items.itemnotes", $fwk );
1713
1714                 # warn "items.itemnotes : $tag , $subfield";
1715                 if ( $marcrecord->field($tag) ) {
1716                     $marcrecord->field($tag)
1717                       ->add_subfields( "$subfield" => $info->{notes} );
1718                 }
1719                 else {
1720                     my $newField =
1721                       MARC::Field->new( "$tag", '', '',
1722                         "$subfield" => $info->{notes} );
1723                     $marcrecord->insert_fields_ordered($newField);
1724                 }
1725             }
1726             if ( $info->{location} ) {
1727                 my ( $tag, $subfield ) =
1728                   GetMarcFromKohaField( "items.location", $fwk );
1729
1730                 # warn "items.location : $tag , $subfield";
1731                 if ( $marcrecord->field($tag) ) {
1732                     $marcrecord->field($tag)
1733                       ->add_subfields( "$subfield" => $info->{location} );
1734                 }
1735                 else {
1736                     my $newField =
1737                       MARC::Field->new( "$tag", '', '',
1738                         "$subfield" => $info->{location} );
1739                     $marcrecord->insert_fields_ordered($newField);
1740                 }
1741             }
1742             if ( $info->{status} ) {
1743                 my ( $tag, $subfield ) =
1744                   GetMarcFromKohaField( "items.notforloan",
1745                     $fwk );
1746
1747                 # warn "items.notforloan : $tag , $subfield";
1748                 if ( $marcrecord->field($tag) ) {
1749                     $marcrecord->field($tag)
1750                       ->add_subfields( "$subfield" => $info->{status} );
1751                 }
1752                 else {
1753                     my $newField =
1754                       MARC::Field->new( "$tag", '', '',
1755                         "$subfield" => $info->{status} );
1756                     $marcrecord->insert_fields_ordered($newField);
1757                 }
1758             }
1759             if ( C4::Context->preference("RoutingSerials") ) {
1760                 my ( $tag, $subfield ) =
1761                   GetMarcFromKohaField( "items.dateaccessioned",
1762                     $fwk );
1763                 if ( $marcrecord->field($tag) ) {
1764                     $marcrecord->field($tag)
1765                       ->add_subfields( "$subfield" => $now );
1766                 }
1767                 else {
1768                     my $newField =
1769                       MARC::Field->new( "$tag", '', '', "$subfield" => $now );
1770                     $marcrecord->insert_fields_ordered($newField);
1771                 }
1772             }
1773             AddItemFromMarc( $marcrecord, $data->{'biblionumber'} );
1774             return 1;
1775         }
1776         return ( 0, @errors );
1777     }
1778 }
1779
1780 =head2 HasSubscriptionExpired
1781
1782 =over 4
1783
1784 $has_expired = HasSubscriptionExpired($subscriptionid)
1785
1786 the subscription has expired when the next issue to arrive is out of subscription limit.
1787
1788 return :
1789 0 if the subscription has not expired
1790 1 if the subscription has expired
1791 2 if has subscription does not have a valid expiration date set
1792
1793 =back
1794
1795 =cut
1796
1797 sub HasSubscriptionExpired {
1798     my ($subscriptionid) = @_;
1799     my $dbh              = C4::Context->dbh;
1800     my $subscription     = GetSubscription($subscriptionid);
1801     if (($subscription->{periodicity} % 16)>0){
1802       my $expirationdate   = GetExpirationDate($subscriptionid);
1803       my $query = qq|
1804             SELECT max(planneddate)
1805             FROM   serial
1806             WHERE  subscriptionid=?
1807       |;
1808       my $sth = $dbh->prepare($query);
1809       $sth->execute($subscriptionid);
1810       my ($res) = $sth->fetchrow  ;
1811           return 0 unless $res;
1812       my @res=split (/-/,$res);
1813       my @endofsubscriptiondate=split(/-/,$expirationdate);
1814       return 2 if (scalar(@res)!=3 || scalar(@endofsubscriptiondate)!=3||not check_date(@res) || not check_date(@endofsubscriptiondate));
1815       return 1 if ( (@endofsubscriptiondate && Delta_Days($res[0],$res[1],$res[2],
1816                   $endofsubscriptiondate[0],$endofsubscriptiondate[1],$endofsubscriptiondate[2]) <= 0)
1817                   || (!$res));
1818       return 0;
1819     } else {
1820       if ($subscription->{'numberlength'}){
1821         my $countreceived=countissuesfrom($subscriptionid,$subscription->{'startdate'});
1822         return 1 if ($countreceived >$subscription->{'numberlength'});
1823               return 0;
1824       } else {
1825               return 0;
1826       }
1827     }
1828     return 0;   # Notice that you'll never get here.
1829 }
1830
1831 =head2 SetDistributedto
1832
1833 =over 4
1834
1835 SetDistributedto($distributedto,$subscriptionid);
1836 This function update the value of distributedto for a subscription given on input arg.
1837
1838 =back
1839
1840 =cut
1841
1842 sub SetDistributedto {
1843     my ( $distributedto, $subscriptionid ) = @_;
1844     my $dbh   = C4::Context->dbh;
1845     my $query = qq|
1846         UPDATE subscription
1847         SET    distributedto=?
1848         WHERE  subscriptionid=?
1849     |;
1850     my $sth = $dbh->prepare($query);
1851     $sth->execute( $distributedto, $subscriptionid );
1852 }
1853
1854 =head2 DelSubscription
1855
1856 =over 4
1857
1858 DelSubscription($subscriptionid)
1859 this function delete the subscription which has $subscriptionid as id.
1860
1861 =back
1862
1863 =cut
1864
1865 sub DelSubscription {
1866     my ($subscriptionid) = @_;
1867     my $dbh = C4::Context->dbh;
1868     $subscriptionid = $dbh->quote($subscriptionid);
1869     $dbh->do("DELETE FROM subscription WHERE subscriptionid=$subscriptionid");
1870     $dbh->do(
1871         "DELETE FROM subscriptionhistory WHERE subscriptionid=$subscriptionid");
1872     $dbh->do("DELETE FROM serial WHERE subscriptionid=$subscriptionid");
1873     
1874     logaction("SERIAL", "DELETE", $subscriptionid, "") if C4::Context->preference("SubscriptionLog");
1875 }
1876
1877 =head2 DelIssue
1878
1879 =over 4
1880
1881 DelIssue($serialseq,$subscriptionid)
1882 this function delete an issue which has $serialseq and $subscriptionid given on input arg.
1883
1884 =back
1885
1886 =cut
1887
1888 sub DelIssue {
1889     my ( $dataissue) = @_;
1890     my $dbh   = C4::Context->dbh;
1891     ### TODO Add itemdeletion. Would need to get itemnumbers. Should be in a pref ?
1892     
1893     my $query = qq|
1894         DELETE FROM serial
1895         WHERE       serialid= ?
1896         AND         subscriptionid= ?
1897     |;
1898     my $mainsth = $dbh->prepare($query);
1899     $mainsth->execute( $dataissue->{'serialid'}, $dataissue->{'subscriptionid'});
1900
1901     #Delete element from subscription history
1902     $query = "SELECT * FROM   subscription WHERE  subscriptionid = ?";
1903     my $sth   = $dbh->prepare($query);
1904     $sth->execute($dataissue->{'subscriptionid'});
1905     my $val = $sth->fetchrow_hashref;
1906     unless ( $val->{manualhistory} ) {
1907         my $query = qq|
1908           SELECT * FROM subscriptionhistory
1909           WHERE       subscriptionid= ?
1910       |;
1911         my $sth = $dbh->prepare($query);
1912         $sth->execute($dataissue->{'subscriptionid'});
1913         my $data = $sth->fetchrow_hashref;
1914         my $serialseq= $dataissue->{'serialseq'};
1915         $data->{'missinglist'}  =~ s/\b$serialseq\b//;
1916         $data->{'recievedlist'} =~ s/\b$serialseq\b//;
1917         my $strsth = "UPDATE subscriptionhistory SET "
1918           . join( ",",
1919             map { join( "=", $_, $dbh->quote( $data->{$_} ) ) } keys %$data )
1920           . " WHERE subscriptionid=?";
1921         $sth = $dbh->prepare($strsth);
1922         $sth->execute($dataissue->{'subscriptionid'});
1923     }
1924     
1925     return $mainsth->rows;
1926 }
1927
1928 =head2 GetLateOrMissingIssues
1929
1930 =over 4
1931
1932 ($count,@issuelist) = &GetLateMissingIssues($supplierid,$serialid)
1933
1934 this function select missing issues on database - where serial.status = 4 or serial.status=3 or planneddate<now
1935
1936 return :
1937 a count of the number of missing issues
1938 the issuelist into a table. Each line of this table containts a ref to a hash which it containts
1939 name,title,planneddate,serialseq,serial.subscriptionid from tables : subscription, serial & biblio
1940
1941 =back
1942
1943 =cut
1944
1945 sub GetLateOrMissingIssues {
1946     my ( $supplierid, $serialid,$order ) = @_;
1947     my $dbh = C4::Context->dbh;
1948     my $sth;
1949     my $byserial = '';
1950     if ($serialid) {
1951         $byserial = "and serialid = " . $serialid;
1952     }
1953     if ($order){
1954       $order.=", title";
1955     } else {
1956       $order="title";
1957     }
1958     if ($supplierid) {
1959         $sth = $dbh->prepare(
1960 "SELECT
1961    serialid,
1962    aqbooksellerid,
1963    name,
1964    biblio.title,
1965    planneddate,
1966    serialseq,
1967    serial.status,
1968    serial.subscriptionid,
1969    claimdate
1970 FROM      serial 
1971 LEFT JOIN subscription  ON serial.subscriptionid=subscription.subscriptionid 
1972 LEFT JOIN biblio        ON subscription.biblionumber=biblio.biblionumber
1973 LEFT JOIN aqbooksellers ON subscription.aqbooksellerid = aqbooksellers.id
1974 WHERE subscription.subscriptionid = serial.subscriptionid 
1975 AND (serial.STATUS = 4 OR ((planneddate < now() AND serial.STATUS =1) OR serial.STATUS = 3))
1976 AND subscription.aqbooksellerid=$supplierid
1977 $byserial
1978 ORDER BY $order"
1979         );
1980     }
1981     else {
1982         $sth = $dbh->prepare(
1983 "SELECT 
1984    serialid,
1985    aqbooksellerid,
1986    name,
1987    biblio.title,
1988    planneddate,
1989    serialseq,
1990    serial.status,
1991    serial.subscriptionid,
1992    claimdate
1993 FROM serial 
1994 LEFT JOIN subscription 
1995 ON serial.subscriptionid=subscription.subscriptionid 
1996 LEFT JOIN biblio 
1997 ON subscription.biblionumber=biblio.biblionumber
1998 LEFT JOIN aqbooksellers 
1999 ON subscription.aqbooksellerid = aqbooksellers.id
2000 WHERE 
2001    subscription.subscriptionid = serial.subscriptionid 
2002 AND (serial.STATUS = 4 OR ((planneddate < now() AND serial.STATUS =1) OR serial.STATUS = 3))
2003 $byserial
2004 ORDER BY $order"
2005         );
2006     }
2007     $sth->execute;
2008     my @issuelist;
2009     my $last_title;
2010     my $odd   = 0;
2011     my $count = 0;
2012     while ( my $line = $sth->fetchrow_hashref ) {
2013         $odd++ unless $line->{title} eq $last_title;
2014         $last_title = $line->{title} if ( $line->{title} );
2015         $line->{planneddate} = format_date( $line->{planneddate} );
2016         $line->{claimdate}   = format_date( $line->{claimdate} );
2017         $line->{"status".$line->{status}}   = 1;
2018         $line->{'odd'} = 1 if $odd % 2;
2019         $count++;
2020         push @issuelist, $line;
2021     }
2022     return $count, @issuelist;
2023 }
2024
2025 =head2 removeMissingIssue
2026
2027 =over 4
2028
2029 removeMissingIssue($subscriptionid)
2030
2031 this function removes an issue from being part of the missing string in 
2032 subscriptionlist.missinglist column
2033
2034 called when a missing issue is found from the serials-recieve.pl file
2035
2036 =back
2037
2038 =cut
2039
2040 sub removeMissingIssue {
2041     my ( $sequence, $subscriptionid ) = @_;
2042     my $dbh = C4::Context->dbh;
2043     my $sth =
2044       $dbh->prepare(
2045         "SELECT * FROM subscriptionhistory WHERE subscriptionid = ?");
2046     $sth->execute($subscriptionid);
2047     my $data              = $sth->fetchrow_hashref;
2048     my $missinglist       = $data->{'missinglist'};
2049     my $missinglistbefore = $missinglist;
2050
2051     # warn $missinglist." before";
2052     $missinglist =~ s/($sequence)//;
2053
2054     # warn $missinglist." after";
2055     if ( $missinglist ne $missinglistbefore ) {
2056         $missinglist =~ s/\|\s\|/\|/g;
2057         $missinglist =~ s/^\| //g;
2058         $missinglist =~ s/\|$//g;
2059         my $sth2 = $dbh->prepare(
2060             "UPDATE subscriptionhistory
2061                                        SET missinglist = ?
2062                                        WHERE subscriptionid = ?"
2063         );
2064         $sth2->execute( $missinglist, $subscriptionid );
2065     }
2066 }
2067
2068 =head2 updateClaim
2069
2070 =over 4
2071
2072 &updateClaim($serialid)
2073
2074 this function updates the time when a claim is issued for late/missing items
2075
2076 called from claims.pl file
2077
2078 =back
2079
2080 =cut
2081
2082 sub updateClaim {
2083     my ($serialid) = @_;
2084     my $dbh        = C4::Context->dbh;
2085     my $sth        = $dbh->prepare(
2086         "UPDATE serial SET claimdate = now()
2087                                    WHERE serialid = ?
2088                                    "
2089     );
2090     $sth->execute($serialid);
2091 }
2092
2093 =head2 getsupplierbyserialid
2094
2095 =over 4
2096
2097 ($result) = &getsupplierbyserialid($serialid)
2098
2099 this function is used to find the supplier id given a serial id
2100
2101 return :
2102 hashref containing serialid, subscriptionid, and aqbooksellerid
2103
2104 =back
2105
2106 =cut
2107
2108 sub getsupplierbyserialid {
2109     my ($serialid) = @_;
2110     my $dbh        = C4::Context->dbh;
2111     my $sth        = $dbh->prepare(
2112         "SELECT serialid, serial.subscriptionid, aqbooksellerid
2113          FROM serial 
2114          LEFT JOIN subscription ON serial.subscriptionid = subscription.subscriptionid
2115          WHERE serialid = ?
2116                                    "
2117     );
2118     $sth->execute($serialid);
2119     my $line   = $sth->fetchrow_hashref;
2120     my $result = $line->{'aqbooksellerid'};
2121     return $result;
2122 }
2123
2124 =head2 check_routing
2125
2126 =over 4
2127
2128 ($result) = &check_routing($subscriptionid)
2129
2130 this function checks to see if a serial has a routing list and returns the count of routingid
2131 used to show either an 'add' or 'edit' link
2132
2133 =back
2134
2135 =cut
2136
2137 sub check_routing {
2138     my ($subscriptionid) = @_;
2139     my $dbh              = C4::Context->dbh;
2140     my $sth              = $dbh->prepare(
2141 "SELECT count(routingid) routingids FROM subscription LEFT JOIN subscriptionroutinglist 
2142                               ON subscription.subscriptionid = subscriptionroutinglist.subscriptionid
2143                               WHERE subscription.subscriptionid = ? ORDER BY ranking ASC
2144                               "
2145     );
2146     $sth->execute($subscriptionid);
2147     my $line   = $sth->fetchrow_hashref;
2148     my $result = $line->{'routingids'};
2149     return $result;
2150 }
2151
2152 =head2 addroutingmember
2153
2154 =over 4
2155
2156 &addroutingmember($borrowernumber,$subscriptionid)
2157
2158 this function takes a borrowernumber and subscriptionid and add the member to the
2159 routing list for that serial subscription and gives them a rank on the list
2160 of either 1 or highest current rank + 1
2161
2162 =back
2163
2164 =cut
2165
2166 sub addroutingmember {
2167     my ( $borrowernumber, $subscriptionid ) = @_;
2168     my $rank;
2169     my $dbh = C4::Context->dbh;
2170     my $sth =
2171       $dbh->prepare(
2172 "SELECT max(ranking) rank FROM subscriptionroutinglist WHERE subscriptionid = ?"
2173       );
2174     $sth->execute($subscriptionid);
2175     while ( my $line = $sth->fetchrow_hashref ) {
2176         if ( $line->{'rank'} > 0 ) {
2177             $rank = $line->{'rank'} + 1;
2178         }
2179         else {
2180             $rank = 1;
2181         }
2182     }
2183     $sth =
2184       $dbh->prepare(
2185 "INSERT INTO subscriptionroutinglist (subscriptionid,borrowernumber,ranking) VALUES (?,?,?)"
2186       );
2187     $sth->execute( $subscriptionid, $borrowernumber, $rank );
2188 }
2189
2190 =head2 reorder_members
2191
2192 =over 4
2193
2194 &reorder_members($subscriptionid,$routingid,$rank)
2195
2196 this function is used to reorder the routing list
2197
2198 it takes the routingid of the member one wants to re-rank and the rank it is to move to
2199 - it gets all members on list puts their routingid's into an array
2200 - removes the one in the array that is $routingid
2201 - then reinjects $routingid at point indicated by $rank
2202 - then update the database with the routingids in the new order
2203
2204 =back
2205
2206 =cut
2207
2208 sub reorder_members {
2209     my ( $subscriptionid, $routingid, $rank ) = @_;
2210     my $dbh = C4::Context->dbh;
2211     my $sth =
2212       $dbh->prepare(
2213 "SELECT * FROM subscriptionroutinglist WHERE subscriptionid = ? ORDER BY ranking ASC"
2214       );
2215     $sth->execute($subscriptionid);
2216     my @result;
2217     while ( my $line = $sth->fetchrow_hashref ) {
2218         push( @result, $line->{'routingid'} );
2219     }
2220
2221     # To find the matching index
2222     my $i;
2223     my $key = -1;    # to allow for 0 being a valid response
2224     for ( $i = 0 ; $i < @result ; $i++ ) {
2225         if ( $routingid == $result[$i] ) {
2226             $key = $i;    # save the index
2227             last;
2228         }
2229     }
2230
2231     # if index exists in array then move it to new position
2232     if ( $key > -1 && $rank > 0 ) {
2233         my $new_rank = $rank -
2234           1;    # $new_rank is what you want the new index to be in the array
2235         my $moving_item = splice( @result, $key, 1 );
2236         splice( @result, $new_rank, 0, $moving_item );
2237     }
2238     for ( my $j = 0 ; $j < @result ; $j++ ) {
2239         my $sth =
2240           $dbh->prepare( "UPDATE subscriptionroutinglist SET ranking = '"
2241               . ( $j + 1 )
2242               . "' WHERE routingid = '"
2243               . $result[$j]
2244               . "'" );
2245         $sth->execute;
2246     }
2247 }
2248
2249 =head2 delroutingmember
2250
2251 =over 4
2252
2253 &delroutingmember($routingid,$subscriptionid)
2254
2255 this function either deletes one member from routing list if $routingid exists otherwise
2256 deletes all members from the routing list
2257
2258 =back
2259
2260 =cut
2261
2262 sub delroutingmember {
2263
2264 # if $routingid exists then deletes that row otherwise deletes all with $subscriptionid
2265     my ( $routingid, $subscriptionid ) = @_;
2266     my $dbh = C4::Context->dbh;
2267     if ($routingid) {
2268         my $sth =
2269           $dbh->prepare(
2270             "DELETE FROM subscriptionroutinglist WHERE routingid = ?");
2271         $sth->execute($routingid);
2272         reorder_members( $subscriptionid, $routingid );
2273     }
2274     else {
2275         my $sth =
2276           $dbh->prepare(
2277             "DELETE FROM subscriptionroutinglist WHERE subscriptionid = ?");
2278         $sth->execute($subscriptionid);
2279     }
2280 }
2281
2282 =head2 getroutinglist
2283
2284 =over 4
2285
2286 ($count,@routinglist) = &getroutinglist($subscriptionid)
2287
2288 this gets the info from the subscriptionroutinglist for $subscriptionid
2289
2290 return :
2291 a count of the number of members on routinglist
2292 the routinglist into a table. Each line of this table containts a ref to a hash which containts
2293 routingid - a unique id, borrowernumber, ranking, and biblionumber of subscription
2294
2295 =back
2296
2297 =cut
2298
2299 sub getroutinglist {
2300     my ($subscriptionid) = @_;
2301     my $dbh              = C4::Context->dbh;
2302     my $sth              = $dbh->prepare(
2303         "SELECT routingid, borrowernumber,
2304                               ranking, biblionumber 
2305          FROM subscription 
2306          LEFT JOIN subscriptionroutinglist ON subscription.subscriptionid = subscriptionroutinglist.subscriptionid
2307          WHERE subscription.subscriptionid = ? ORDER BY ranking ASC
2308                               "
2309     );
2310     $sth->execute($subscriptionid);
2311     my @routinglist;
2312     my $count = 0;
2313     while ( my $line = $sth->fetchrow_hashref ) {
2314         $count++;
2315         push( @routinglist, $line );
2316     }
2317     return ( $count, @routinglist );
2318 }
2319
2320 =head2 countissuesfrom
2321
2322 =over 4
2323
2324 $result = &countissuesfrom($subscriptionid,$startdate)
2325
2326
2327 =back
2328
2329 =cut
2330
2331 sub countissuesfrom {
2332     my ($subscriptionid,$startdate) = @_;
2333     my $dbh              = C4::Context->dbh;
2334     my $query = qq|
2335             SELECT count(*)
2336             FROM   serial
2337             WHERE  subscriptionid=?
2338             AND serial.publisheddate>?
2339         |;
2340     my $sth=$dbh->prepare($query);
2341     $sth->execute($subscriptionid, $startdate);
2342     my ($countreceived)=$sth->fetchrow;
2343     return $countreceived;  
2344 }
2345
2346 =head2 abouttoexpire
2347
2348 =over 4
2349
2350 $result = &abouttoexpire($subscriptionid)
2351
2352 this function alerts you to the penultimate issue for a serial subscription
2353
2354 returns 1 - if this is the penultimate issue
2355 returns 0 - if not
2356
2357 =back
2358
2359 =cut
2360
2361 sub abouttoexpire {
2362     my ($subscriptionid) = @_;
2363     my $dbh              = C4::Context->dbh;
2364     my $subscription     = GetSubscription($subscriptionid);
2365     my $per = $subscription->{'periodicity'};
2366     if ($per % 16>0){
2367       my $expirationdate   = GetExpirationDate($subscriptionid);
2368       my $sth =
2369         $dbh->prepare(
2370           "select max(planneddate) from serial where subscriptionid=?");
2371       $sth->execute($subscriptionid);
2372       my ($res) = $sth->fetchrow ;
2373 #        warn "date expiration : ".$expirationdate." date courante ".$res;
2374       my @res=split (/-/,$res);
2375       @res=Date::Calc::Today if ($res[0]*$res[1]==0);
2376       my @endofsubscriptiondate=split(/-/,$expirationdate);
2377       my $x;
2378       if ( $per == 1 ) {$x=7;}
2379       if ( $per == 2 ) {$x=7; }
2380       if ( $per == 3 ) {$x=14;}
2381       if ( $per == 4 ) { $x = 21; }
2382       if ( $per == 5 ) { $x = 31; }
2383       if ( $per == 6 ) { $x = 62; }
2384       if ( $per == 7 || $per == 8 ) { $x = 93; }
2385       if ( $per == 9 )  { $x = 190; }
2386       if ( $per == 10 ) { $x = 365; }
2387       if ( $per == 11 ) { $x = 730; }
2388       my @datebeforeend=Add_Delta_Days(  $endofsubscriptiondate[0],$endofsubscriptiondate[1],$endofsubscriptiondate[2],
2389                     - (3 * $x)) if (@endofsubscriptiondate && $endofsubscriptiondate[0]*$endofsubscriptiondate[1]*$endofsubscriptiondate[2]);
2390               # warn "DATE BEFORE END: $datebeforeend";
2391       return 1 if ( @res && 
2392                     (@datebeforeend && 
2393                         Delta_Days($res[0],$res[1],$res[2],
2394                         $datebeforeend[0],$datebeforeend[1],$datebeforeend[2]) <= 0) && 
2395                     (@endofsubscriptiondate && 
2396                         Delta_Days($res[0],$res[1],$res[2],
2397                         $endofsubscriptiondate[0],$endofsubscriptiondate[1],$endofsubscriptiondate[2]) >= 0) );
2398     return 0;
2399    } elsif ($subscription->{numberlength}>0) {
2400     return (countissuesfrom($subscriptionid,$subscription->{'startdate'}) >=$subscription->{numberlength}-1);
2401    } else {return 0}
2402 }
2403
2404 =head2 old_newsubscription
2405
2406 =over 4
2407
2408 ($subscriptionid) = &old_newsubscription($auser,$aqbooksellerid,$cost,$aqbudgetid,$biblionumber,
2409                         $startdate,$periodicity,$firstacquidate,$dow,$irregularity,$numberpattern,$numberlength,$weeklength,$monthlength,
2410                         $add1,$every1,$whenmorethan1,$setto1,$lastvalue1,
2411                         $add2,$every2,$whenmorethan2,$setto2,$lastvalue2,
2412                         $add3,$every3,$whenmorethan3,$setto3,$lastvalue3,
2413                         $numberingmethod, $status, $callnumber, $notes, $hemisphere)
2414
2415 this function is similar to the NewSubscription subroutine but has a few different
2416 values passed in 
2417 $firstacquidate - date of first serial issue to arrive
2418 $irregularity - the issues not expected separated by a '|'
2419 - eg. monthly issue but not expecting issue for june and july would have $irregularity of '6|7'
2420 $numberpattern - the number for an array of labels to reconstruct the javascript correctly in the 
2421    subscription-add.tmpl file
2422 $callnumber - display the callnumber of the serial
2423 $hemisphere - either 2 = southern hemisphere or 1 = northern hemisphere - used for quarterly serials
2424
2425 return :
2426 the $subscriptionid number of the new subscription
2427
2428 =back
2429
2430 =cut
2431
2432 sub old_newsubscription {
2433     my (
2434         $auser,         $aqbooksellerid,  $cost,          $aqbudgetid,
2435         $biblionumber,  $startdate,       $periodicity,   $firstacquidate,
2436         $dow,           $irregularity,    $numberpattern, $numberlength,
2437         $weeklength,    $monthlength,     $add1,          $every1,
2438         $whenmorethan1, $setto1,          $lastvalue1,    $add2,
2439         $every2,        $whenmorethan2,   $setto2,        $lastvalue2,
2440         $add3,          $every3,          $whenmorethan3, $setto3,
2441         $lastvalue3,    $numberingmethod, $status,        $callnumber,
2442         $notes,         $hemisphere
2443     ) = @_;
2444     my $dbh = C4::Context->dbh;
2445
2446     #save subscription
2447     my $sth = $dbh->prepare(
2448 "insert into subscription (librarian,aqbooksellerid,cost,aqbudgetid,biblionumber,
2449                                                         startdate,periodicity,firstacquidate,dow,irregularity,numberpattern,numberlength,weeklength,monthlength,
2450                                                                 add1,every1,whenmorethan1,setto1,lastvalue1,
2451                                                                 add2,every2,whenmorethan2,setto2,lastvalue2,
2452                                                                 add3,every3,whenmorethan3,setto3,lastvalue3,
2453                                                                 numberingmethod, status, callnumber, notes, hemisphere) values
2454                                                           (?,?,?,?,?,?,?,?,?,?,?,
2455                                                                                            ?,?,?,?,?,?,?,?,?,?,?,
2456                                                                                            ?,?,?,?,?,?,?,?,?,?,?,?)"
2457     );
2458     $sth->execute(
2459         $auser,         $aqbooksellerid,
2460         $cost,          $aqbudgetid,
2461         $biblionumber,  format_date_in_iso($startdate),
2462         $periodicity,   format_date_in_iso($firstacquidate),
2463         $dow,           $irregularity,
2464         $numberpattern, $numberlength,
2465         $weeklength,    $monthlength,
2466         $add1,          $every1,
2467         $whenmorethan1, $setto1,
2468         $lastvalue1,    $add2,
2469         $every2,        $whenmorethan2,
2470         $setto2,        $lastvalue2,
2471         $add3,          $every3,
2472         $whenmorethan3, $setto3,
2473         $lastvalue3,    $numberingmethod,
2474         $status,        $callnumber,
2475         $notes,         $hemisphere
2476     );
2477
2478     #then create the 1st waited number
2479     my $subscriptionid = $dbh->{'mysql_insertid'};
2480     my $enddate        = GetExpirationDate($subscriptionid);
2481
2482     $sth =
2483       $dbh->prepare(
2484 "insert into subscriptionhistory (biblionumber, subscriptionid, histstartdate, enddate, missinglist, recievedlist, opacnote, librariannote) values (?,?,?,?,?,?,?,?)"
2485       );
2486     $sth->execute(
2487         $biblionumber, $subscriptionid,
2488         format_date_in_iso($startdate),
2489         format_date_in_iso($enddate),
2490         "", "", "", $notes
2491     );
2492
2493    # reread subscription to get a hash (for calculation of the 1st issue number)
2494     $sth =
2495       $dbh->prepare("select * from subscription where subscriptionid = ? ");
2496     $sth->execute($subscriptionid);
2497     my $val = $sth->fetchrow_hashref;
2498
2499     # calculate issue number
2500     my $serialseq = GetSeq($val);
2501     $sth =
2502       $dbh->prepare(
2503 "insert into serial (serialseq,subscriptionid,biblionumber,status, planneddate) values (?,?,?,?,?)"
2504       );
2505     $sth->execute( $serialseq, $subscriptionid, $val->{'biblionumber'},
2506         1, format_date_in_iso($startdate) );
2507     return $subscriptionid;
2508 }
2509
2510 =head2 old_modsubscription
2511
2512 =over 4
2513
2514 ($subscriptionid) = &old_modsubscription($auser,$aqbooksellerid,$cost,$aqbudgetid,$biblionumber,
2515                         $startdate,$periodicity,$firstacquidate,$dow,$irregularity,$numberpattern,$numberlength,$weeklength,$monthlength,
2516                         $add1,$every1,$whenmorethan1,$setto1,$lastvalue1,
2517                         $add2,$every2,$whenmorethan2,$setto2,$lastvalue2,
2518                         $add3,$every3,$whenmorethan3,$setto3,$lastvalue3,
2519                         $numberingmethod, $status, $callnumber, $notes, $hemisphere, $subscriptionid)
2520
2521 this function is similar to the ModSubscription subroutine but has a few different
2522 values passed in 
2523 $firstacquidate - date of first serial issue to arrive
2524 $irregularity - the issues not expected separated by a '|'
2525 - eg. monthly issue but not expecting issue for june and july would have $irregularity of '6|7'
2526 $numberpattern - the number for an array of labels to reconstruct the javascript correctly in the 
2527    subscription-add.tmpl file
2528 $callnumber - display the callnumber of the serial
2529 $hemisphere - either 2 = southern hemisphere or 1 = northern hemisphere - used for quarterly serials
2530
2531 =back
2532
2533 =cut
2534
2535 sub old_modsubscription {
2536     my (
2537         $auser,        $aqbooksellerid, $cost,           $aqbudgetid,
2538         $startdate,    $periodicity,    $firstacquidate, $dow,
2539         $irregularity, $numberpattern,  $numberlength,   $weeklength,
2540         $monthlength,  $add1,           $every1,         $whenmorethan1,
2541         $setto1,       $lastvalue1,     $innerloop1,     $add2,
2542         $every2,       $whenmorethan2,  $setto2,         $lastvalue2,
2543         $innerloop2,   $add3,           $every3,         $whenmorethan3,
2544         $setto3,       $lastvalue3,     $innerloop3,     $numberingmethod,
2545         $status,       $biblionumber,   $callnumber,     $notes,
2546         $hemisphere,   $subscriptionid
2547     ) = @_;
2548     my $dbh = C4::Context->dbh;
2549     my $sth = $dbh->prepare(
2550 "update subscription set librarian=?, aqbooksellerid=?,cost=?,aqbudgetid=?,startdate=?,
2551                                                    periodicity=?,firstacquidate=?,dow=?,irregularity=?,numberpattern=?,numberlength=?,weeklength=?,monthlength=?,
2552                                                   add1=?,every1=?,whenmorethan1=?,setto1=?,lastvalue1=?,innerloop1=?,
2553                                                   add2=?,every2=?,whenmorethan2=?,setto2=?,lastvalue2=?,innerloop2=?,
2554                                                   add3=?,every3=?,whenmorethan3=?,setto3=?,lastvalue3=?,innerloop3=?,
2555                                                   numberingmethod=?, status=?, biblionumber=?, callnumber=?, notes=?, hemisphere=? where subscriptionid = ?"
2556     );
2557     $sth->execute(
2558         $auser,        $aqbooksellerid, $cost,           $aqbudgetid,
2559         $startdate,    $periodicity,    $firstacquidate, $dow,
2560         $irregularity, $numberpattern,  $numberlength,   $weeklength,
2561         $monthlength,  $add1,           $every1,         $whenmorethan1,
2562         $setto1,       $lastvalue1,     $innerloop1,     $add2,
2563         $every2,       $whenmorethan2,  $setto2,         $lastvalue2,
2564         $innerloop2,   $add3,           $every3,         $whenmorethan3,
2565         $setto3,       $lastvalue3,     $innerloop3,     $numberingmethod,
2566         $status,       $biblionumber,   $callnumber,     $notes,
2567         $hemisphere,   $subscriptionid
2568     );
2569     $sth->finish;
2570
2571     $sth =
2572       $dbh->prepare("select * from subscription where subscriptionid = ? ");
2573     $sth->execute($subscriptionid);
2574     my $val = $sth->fetchrow_hashref;
2575
2576     # calculate issue number
2577     my $serialseq = Get_Seq($val);
2578     $sth =
2579       $dbh->prepare("UPDATE serial SET serialseq = ? WHERE subscriptionid = ?");
2580     $sth->execute( $serialseq, $subscriptionid );
2581
2582     my $enddate = subscriptionexpirationdate($subscriptionid);
2583     $sth = $dbh->prepare("update subscriptionhistory set enddate=?");
2584     $sth->execute( format_date_in_iso($enddate) );
2585 }
2586
2587 =head2 old_getserials
2588
2589 =over 4
2590
2591 ($totalissues,@serials) = &old_getserials($subscriptionid)
2592
2593 this function get a hashref of serials and the total count of them
2594
2595 return :
2596 $totalissues - number of serial lines
2597 the serials into a table. Each line of this table containts a ref to a hash which it containts
2598 serialid, serialseq, status,planneddate,notes,routingnotes  from tables : serial where status is not 2, 4, or 5
2599
2600 =back
2601
2602 =cut
2603
2604 sub old_getserials {
2605     my ($subscriptionid) = @_;
2606     my $dbh = C4::Context->dbh;
2607
2608     # status = 2 is "arrived"
2609     my $sth =
2610       $dbh->prepare(
2611 "select serialid,serialseq, status, planneddate,notes,routingnotes from serial where subscriptionid = ? and status <>2 and status <>4 and status <>5"
2612       );
2613     $sth->execute($subscriptionid);
2614     my @serials;
2615     my $num = 1;
2616     while ( my $line = $sth->fetchrow_hashref ) {
2617         $line->{ "status" . $line->{status} } =
2618           1;    # fills a "statusX" value, used for template status select list
2619         $line->{"planneddate"} = format_date( $line->{"planneddate"} );
2620         $line->{"num"}         = $num;
2621         $num++;
2622         push @serials, $line;
2623     }
2624     $sth = $dbh->prepare("select count(*) from serial where subscriptionid=?");
2625     $sth->execute($subscriptionid);
2626     my ($totalissues) = $sth->fetchrow;
2627     return ( $totalissues, @serials );
2628 }
2629
2630 =head2 GetNextDate
2631
2632 ($resultdate) = &GetNextDate($planneddate,$subscription)
2633
2634 this function is an extension of GetNextDate which allows for checking for irregularity
2635
2636 it takes the planneddate and will return the next issue's date and will skip dates if there
2637 exists an irregularity
2638 - eg if periodicity is monthly and $planneddate is 2007-02-10 but if March and April is to be 
2639 skipped then the returned date will be 2007-05-10
2640
2641 return :
2642 $resultdate - then next date in the sequence
2643
2644 Return 0 if periodicity==0
2645
2646 =cut
2647 sub in_array { # used in next sub down
2648   my ($val,@elements) = @_;
2649   foreach my $elem(@elements) {
2650     if($val == $elem) {
2651             return 1;
2652     }
2653   }
2654   return 0;
2655 }
2656
2657 sub GetNextDate(@) {
2658     my ( $planneddate, $subscription ) = @_;
2659     my @irreg = split( /\,/, $subscription->{irregularity} );
2660
2661     #date supposed to be in ISO.
2662     
2663     my ( $year, $month, $day ) = split(/-/, $planneddate);
2664     $month=1 unless ($month);
2665     $day=1 unless ($day);
2666     my @resultdate;
2667
2668     #       warn "DOW $dayofweek";
2669     if ( $subscription->{periodicity} % 16 == 0 ) {  # 'without regularity' || 'irregular'
2670       return 0;
2671     }  
2672     #   daily : n / week
2673     #   Since we're interpreting irregularity here as which days of the week to skip an issue,
2674     #   renaming this pattern from 1/day to " n / week ".
2675     if ( $subscription->{periodicity} == 1 ) {  
2676         my $dayofweek = eval{Day_of_Week( $year,$month, $day )};
2677         if ($@){warn "year month day : $year $month $day $subscription->{subscriptionid} : $@";}
2678         else {    
2679           for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2680               $dayofweek = 0 if ( $dayofweek == 7 ); 
2681               if ( in_array( ($dayofweek + 1), @irreg ) ) {
2682                   ($year,$month,$day) = Add_Delta_Days($year,$month, $day , 1 );
2683                   $dayofweek++;
2684               }
2685           }
2686           @resultdate = Add_Delta_Days($year,$month, $day , 1 );
2687         }    
2688     }
2689     #   1  week
2690     if ( $subscription->{periodicity} == 2 ) {
2691         my ($wkno,$year) = eval {Week_of_Year( $year,$month, $day )};
2692         if ($@){warn "year month day : $year $month $day $subscription->{subscriptionid} : $@";}
2693         else {    
2694           for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2695           #FIXME: if two consecutive irreg, do we only skip one?
2696               if ( $irreg[$i] == (($wkno!=51)?($wkno +1) % 52 :52)) {
2697                   ($year,$month,$day) = Add_Delta_Days($year,$month, $day , 7 );
2698                   $wkno=(($wkno!=51)?($wkno +1) % 52 :52);
2699               }
2700           }
2701           @resultdate = Add_Delta_Days( $year,$month, $day, 7);
2702         }        
2703     }
2704     #   1 / 2 weeks
2705     if ( $subscription->{periodicity} == 3 ) {        
2706         my ($wkno,$year) = eval {Week_of_Year( $year,$month, $day )};
2707         if ($@){warn "year month day : $year $month $day $subscription->{subscriptionid} : $@";}
2708         else {    
2709           for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2710               if ( $irreg[$i] == (($wkno!=50)?($wkno +2) % 52 :52)) {
2711               ### BUGFIX was previously +1 ^
2712                   ($year,$month,$day) = Add_Delta_Days($year,$month, $day , 14 );
2713                   $wkno=(($wkno!=50)?($wkno +2) % 52 :52);
2714               }
2715           }
2716           @resultdate = Add_Delta_Days($year,$month, $day , 14 );
2717         }        
2718     }
2719     #   1 / 3 weeks
2720     if ( $subscription->{periodicity} == 4 ) {
2721         my ($wkno,$year) = eval {Week_of_Year( $year,$month, $day )};
2722         if ($@){warn "annĂ©e mois jour : $year $month $day $subscription->{subscriptionid} : $@";}
2723         else {    
2724           for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2725               if ( $irreg[$i] == (($wkno!=49)?($wkno +3) % 52 :52)) {
2726                   ($year,$month,$day) = Add_Delta_Days($year,$month, $day , 21 );
2727                   $wkno=(($wkno!=49)?($wkno +3) % 52 :52);
2728               }
2729           }
2730           @resultdate = Add_Delta_Days($year,$month, $day , 21 );
2731         }        
2732     }
2733     my $tmpmonth=$month;
2734     if ($year && $month && $day){
2735     if ( $subscription->{periodicity} == 5 ) {
2736           for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2737               if ( $irreg[$i] == (($tmpmonth!=11)?($tmpmonth +1) % 12 :12)) {
2738                   ($year,$month,$day) = Add_Delta_YMD($year,$month, $day ,0,1,0 );
2739                   $tmpmonth=(($tmpmonth!=11)?($tmpmonth +1) % 12 :12);
2740               }
2741           }        
2742           @resultdate = Add_Delta_YMD($year,$month, $day ,0,1,0 );
2743     }
2744     if ( $subscription->{periodicity} == 6 ) {
2745           for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2746               if ( $irreg[$i] == (($tmpmonth!=10)?($tmpmonth +2) % 12 :12)) {
2747                   ($year,$month,$day) = Add_Delta_YMD($year,$month, $day ,0,2,0 );
2748                   $tmpmonth=(($tmpmonth!=10)?($tmpmonth + 2) % 12 :12);
2749               }
2750           }
2751           @resultdate = Add_Delta_YMD($year,$month, $day, 0, 2,0 );
2752     }
2753     if ( $subscription->{periodicity} == 7 ) {
2754         for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2755             if ( $irreg[$i] == (($tmpmonth!=9)?($tmpmonth +3) % 12 :12)) {
2756                 ($year,$month,$day) = Add_Delta_YMD($year,$month, $day, 0, 3,0 );
2757                 $tmpmonth=(($tmpmonth!=9)?($tmpmonth + 3) % 12 :12);
2758             }
2759         }
2760         @resultdate = Add_Delta_YMD($year,$month, $day, 0, 3, 0);
2761     }
2762     if ( $subscription->{periodicity} == 8 ) {
2763         for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2764             if ( $irreg[$i] == (($tmpmonth!=9)?($tmpmonth +3) % 12 :12)) {
2765                 ($year,$month,$day) = Add_Delta_YMD($year,$month, $day, 0, 3,0 );
2766                 $tmpmonth=(($tmpmonth!=9)?($tmpmonth + 3) % 12 :12);
2767             }
2768         }
2769         @resultdate = Add_Delta_YMD($year,$month, $day, 0, 3, 0);
2770     }
2771     if ( $subscription->{periodicity} == 9 ) {
2772         for ( my $i = 0 ; $i < @irreg ; $i++ ) {
2773             if ( $irreg[$i] == (($tmpmonth!=9)?($tmpmonth +3) % 12 :12)) {
2774             ### BUFIX Seems to need more Than One ?
2775                 ($year,$month,$day) = Add_Delta_YM($year,$month, $day, 0, 6 );
2776                 $tmpmonth=(($tmpmonth!=6)?($tmpmonth + 6) % 12 :12);
2777             }
2778         }
2779         @resultdate = Add_Delta_YM($year,$month, $day, 0, 6);
2780     }
2781     if ( $subscription->{periodicity} == 10 ) {
2782         @resultdate = Add_Delta_YM($year,$month, $day, 1, 0 );
2783     }
2784     if ( $subscription->{periodicity} == 11 ) {
2785         @resultdate = Add_Delta_YM($year,$month, $day, 2, 0 );
2786     }
2787     }  
2788     my $resultdate=sprintf("%04d-%02d-%02d",$resultdate[0],$resultdate[1],$resultdate[2]);
2789       
2790 #     warn "dateNEXTSEQ : ".$resultdate;
2791     return "$resultdate";
2792 }
2793
2794 =head2 itemdata
2795
2796   $item = &itemdata($barcode);
2797
2798 Looks up the item with the given barcode, and returns a
2799 reference-to-hash containing information about that item. The keys of
2800 the hash are the fields from the C<items> and C<biblioitems> tables in
2801 the Koha database.
2802
2803 =cut
2804
2805 #'
2806 sub itemdata {
2807     my ($barcode) = @_;
2808     my $dbh       = C4::Context->dbh;
2809     my $sth       = $dbh->prepare(
2810         "Select * from items LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber 
2811         WHERE barcode=?"
2812     );
2813     $sth->execute($barcode);
2814     my $data = $sth->fetchrow_hashref;
2815     $sth->finish;
2816     return ($data);
2817 }
2818
2819 1;
2820 __END__
2821
2822 =head1 AUTHOR
2823
2824 Koha Developement team <info@koha.org>
2825
2826 =cut