Attachment #56641 for bug #16966

View | Details | Raw Unified | Return to bug 16966
Collapse All | Expand All




        &GetBranchItemRule
		&GetBiblioIssues
		&GetOpenIssue
		&AnonymiseIssueHistory
        &CheckIfIssuedToPatron
        &IsItemIssued
        GetTopIssues

    return $sth->execute($itemnumber);
}

=head2 AnonymiseIssueHistory

  ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)

This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.

If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
setting (force delete).

return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.

=cut

sub AnonymiseIssueHistory {
    my $date           = shift;
    my $borrowernumber = shift;
    my $dbh            = C4::Context->dbh;
    my $query          = "
        UPDATE old_issues
        SET    borrowernumber = ?
        WHERE  returndate < ?
          AND borrowernumber IS NOT NULL
    ";

    # The default of 0 does not work due to foreign key constraints
    # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
    # Set it to undef (NULL)
    my $anonymouspatron = C4::Context->preference('AnonymousPatron') || undef;
    my @bind_params = ($anonymouspatron, $date);
    if (defined $borrowernumber) {
       $query .= " AND borrowernumber = ?";
       push @bind_params, $borrowernumber;
    } else {
       $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
    }
    my $sth = $dbh->prepare($query);
    $sth->execute(@bind_params);
    my $anonymisation_err = $dbh->err;
    my $rows_affected = $sth->rows;  ### doublecheck row count return function
    return ($rows_affected, $anonymisation_err);
}

=head2 SendCirculationAlert

Send out a C<check-in> or C<checkout> alert using the messaging system.





        &GetBorrowersToExpunge
        &GetBorrowersWhoHaveNeverBorrowed
        &GetBorrowersWithIssuesHistoryOlderThan

        &GetUpcomingMembershipExpires


    return \@results;
}

=head2 GetBorrowersWithIssuesHistoryOlderThan

  $results = &GetBorrowersWithIssuesHistoryOlderThan($date)

this function get all borrowers who has an issue history older than I<$date> given on input arg.

I<$result> is a ref to an array which all elements are a hashref.
This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.

=cut

sub GetBorrowersWithIssuesHistoryOlderThan {
    my $dbh  = C4::Context->dbh;
    my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
    my $filterbranch = shift || 
                        ((C4::Context->preference('IndependentBranches')
                             && C4::Context->userenv 
                             && !C4::Context->IsSuperLibrarian()
                             && C4::Context->userenv->{branch})
                         ? C4::Context->userenv->{branch}
                         : "");  
    my $query = "
       SELECT count(borrowernumber) as n,borrowernumber
       FROM old_issues
       WHERE returndate < ?
         AND borrowernumber IS NOT NULL 
    "; 
    my @query_params;
    push @query_params, $date;
    if ($filterbranch){
        $query.="   AND branchcode = ?";
        push @query_params, $filterbranch;
    }    
    $query.=" GROUP BY borrowernumber ";
    warn $query if $debug;
    my $sth = $dbh->prepare($query);
    $sth->execute(@query_params);
    my @results;

    while ( my $data = $sth->fetchrow_hashref ) {
        push @results, $data;
    }
    return \@results;
}

=head2 IssueSlip

  IssueSlip($branchcode, $borrowernumber, $quickslip)




package Koha::Patrons;

# Copyright 2014 ByWater Solutions
# Copyright 2016 Koha Development Team
#
# This file is part of Koha.
#

use Carp;

use Koha::Database;
use Koha::DateUtils;

use Koha::Patron;



=cut

=head3 search_patrons_to_anonymise

    my $patrons = Koha::Patrons->search_patrons_to_anonymise( $date );

This method returns all patrons who has an issue history older than a given date.

=cut

sub search_patrons_to_anonymise {
    my ( $class, $older_than_date, $library ) = @_;
    $older_than_date = $older_than_date ? dt_from_string($older_than_date) : dt_from_string;
    $library ||=
      ( C4::Context->preference('IndependentBranches') && C4::Context->userenv && !C4::Context->IsSuperLibrarian() && C4::Context->userenv->{branch} )
      ? C4::Context->userenv->{branch}
      : undef;

    my $dtf = Koha::Database->new->schema->storage->datetime_parser;
    my $rs = $class->search(
        {   returndate                  => { '<'   =>  $dtf->format_datetime($older_than_date), },
            'old_issues.borrowernumber' => { 'not' => undef },
            privacy                     => { '<>'  => 0 },                  # Keep forever
            ( $library ? ( 'old_issues.branchcode' => $library ) : () ),
        },
        {   join     => ["old_issues"],
            group_by => 'borrowernumber'
        }
    );
    return Koha::Patrons->_new_from_dbic($rs);
}

=head3 anonymise_issue_history

    Koha::Patrons->search->anonymise_issue_history( $older_than_date );

Anonymise issue history (old_issues) for all patrons older than the given date.
To make sure all the conditions are met, the caller has the responsability to
call search_patrons_to_anonymise to filter the Koha::Patrons set

=cut

sub anonymise_issue_history {
    my ( $self, $older_than_date ) = @_;

    return unless $older_than_date;
    $older_than_date = dt_from_string $older_than_date;

    # The default of 0 does not work due to foreign key constraints
    # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
    # Set it to undef (NULL)
    my $dtf = Koha::Database->new->schema->storage->datetime_parser;
    my $old_issues_to_anonymise = $self->search_related( 'old_issues', { returndate => { '<' => $dtf->format_datetime($older_than_date) } } );
    my $anonymous_patron = C4::Context->preference('AnonymousPatron') || undef;
    $old_issues_to_anonymise->update( { 'old_issues.borrowernumber' => $anonymous_patron } );
}

=head3 type

=cut

Lines 217-224 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/cleanborrowers.tt (-2 / +2 lines)
217	<h4>No patron records have been removed</h4>	217	<h4>No patron records have been removed</h4>
218	[% END %]	218	[% END %]
219	[% END %]	219	[% END %]
220	[% IF ( do_anonym ) %]	220	[% IF do_anonym %]
221	<h4>All checkouts older than [% last_issue_date \| $KohaDates %] have been anonymized</h4>	221	<h4>All checkouts ([% do_anonym %]) older than [% last_issue_date \| $KohaDates %] have been anonymized</h4>
222	[% ELSE %]	222	[% ELSE %]
223	<h4>No patron records have been anonymized</h4>	223	<h4>No patron records have been anonymized</h4>
224	[% END %]	224	[% END %]

Lines 25-34 Link Here

(-)a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-privacy.tt (-3 / +3 lines)
25	<div id="userprivacy">	25	<div id="userprivacy">
26	<h3>Your privacy management</h3>	26	<h3>Your privacy management</h3>
27		27
28	[% IF ( deleted ) %]	28	[% IF deleted %]
29	<div class="alert alert-success">Your reading history has been deleted.</div>	29	<div class="alert alert-success">Your reading history has been deleted.</div>
30	[% ELSIF ( err_history_not_deleted ) %]	30	[% ELSE %]
31	<div class="alert">The deletion of your reading history failed, because there is a problem with the configuration of this feature. Please help to fix the system by informing your library of this error.</div>	31	<div class="alert">No reading history to delete</div>
32	[% END %]	32	[% END %]
33		33
34	[% IF ( privacy_updated ) %]	34	[% IF ( privacy_updated ) %]

Lines 30-36 BEGIN { Link Here

(-)a/misc/cronjobs/batch_anonymise.pl (-4 / +3 lines)
30	}	30	}
31		31
32	use C4::Context;	32	use C4::Context;
33	use C4::Circulation;	33	use Koha::Patrons;
34	use Date::Calc qw(	34	use Date::Calc qw(
35	Today	35	Today
36	Add_Delta_Days	36	Add_Delta_Days
Lines 74-81 my ($newyear,$newmonth,$newday) = Add_Delta_Days ($year,$month,$day,(-1)*$days); Link Here
74	my $formatdate = sprintf "%4d-%02d-%02d",$newyear,$newmonth,$newday;	74	my $formatdate = sprintf "%4d-%02d-%02d",$newyear,$newmonth,$newday;
75	$verbose and print "Checkouts before $formatdate will be anonymised.\n";	75	$verbose and print "Checkouts before $formatdate will be anonymised.\n";
76		76
77	my ($rows, $err_history_not_deleted) = AnonymiseIssueHistory($formatdate);	77	my $rows = Koha::Patrons->search_patrons_to_anonymise( $formatdate )->anonymise_issue_history( $formatdate );
78	carp "Anonymisation of reading history failed." if ($err_history_not_deleted);	78	$verbose and print int($rows) . " checkouts anonymised.\n";
79	$verbose and print "$rows checkouts anonymised.\n";
80		79
81	exit(0);	80	exit(0);





use C4::Auth;    # checkauth, getborrowernumber.
use C4::Context;
use C4::Circulation;
use C4::Members;
use C4::Output;
use Koha::Patrons;


    # delete all reading records for items returned
    # uses a hardcoded date ridiculously far in the future
    my ( $rows, $err_history_not_deleted ) =
      AnonymiseIssueHistory( '2999-12-12', $borrowernumber );

    my $rows = eval {
        Koha::Patrons->search({ 'me.borrowernumber' => $borrowernumber })->anonymise_issue_history( '2999-12-12' );
    };
    $rows = $@ ? 0 : int($rows);
    $template->param( 'deleted' => $rows );
        $template->param( 'err_history_not_deleted' => 1 );
    }
}

# get borrower privacy ....




use C4::Auth;
use C4::Output;
use C4::Members;        # GetBorrowersWhoHavexxxBorrowed.
use C4::Circulation;    # AnonymiseIssueHistory.
use Koha::DateUtils qw( dt_from_string output_pref );
use Koha::Patron::Categories;
use Date::Calc qw/Today Add_Delta_YM/;
use Koha::Patrons;
use Koha::List::Patron;

my $cgi = new CGI;

    }
    _skip_borrowers_with_nonzero_balance($patrons_to_delete);

    my $patrons_to_anonymize =
        $checkboxes{issue}
      ? $branch eq '*'
          ? Koha::Patrons->search_patrons_to_anonymise($last_issue_date)
          : Koha::Patrons->search_patrons_to_anonymise( $last_issue_date, $branch )
      : undef;
        }
    }

    $template->param(
        patrons_to_delete    => $patrons_to_delete,
        patrons_to_anonymize => $patrons_to_anonymize,
        patron_list_id       => $patron_list_id,
    );
}


    # Anonymising all members
    if ($do_anonym) {
        #FIXME: anonymisation errors are not handled
        my $rows = Koha::Patrons->search_patrons_to_anonymise( $last_issue_date )->anonymise_issue_history( $last_issue_date );
        $template->param(
            do_anonym   => $rows,
        );
    }

- 

Return to bug 16966

Lines 96-102 BEGIN { Link Here

(-)a/C4/Circulation.pm (-44 lines)
96	&GetBranchItemRule	96	&GetBranchItemRule
97	&GetBiblioIssues	97	&GetBiblioIssues
98	&GetOpenIssue	98	&GetOpenIssue
99	&AnonymiseIssueHistory
100	&CheckIfIssuedToPatron	99	&CheckIfIssuedToPatron
101	&IsItemIssued	100	&IsItemIssued
102	GetTopIssues	101	GetTopIssues
Lines 3316-3364 sub DeleteTransfer { Link Here
3316	return $sth->execute($itemnumber);	3315	return $sth->execute($itemnumber);
3317	}	3316	}
3318		3317
3319	=head2 AnonymiseIssueHistory
3320
3321	($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3322
3323	This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3324	if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3325
3326	If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3327	setting (force delete).
3328
3329	return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3330
3331	=cut
3332
3333	sub AnonymiseIssueHistory {
3334	my $date = shift;
3335	my $borrowernumber = shift;
3336	my $dbh = C4::Context->dbh;
3337	my $query = "
3338	UPDATE old_issues
3339	SET borrowernumber = ?
3340	WHERE returndate < ?
3341	AND borrowernumber IS NOT NULL
3342	";
3343
3344	# The default of 0 does not work due to foreign key constraints
3345	# The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
3346	# Set it to undef (NULL)
3347	my $anonymouspatron = C4::Context->preference('AnonymousPatron') \|\| undef;
3348	my @bind_params = ($anonymouspatron, $date);
3349	if (defined $borrowernumber) {
3350	$query .= " AND borrowernumber = ?";
3351	push @bind_params, $borrowernumber;
3352	} else {
3353	$query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3354	}
3355	my $sth = $dbh->prepare($query);
3356	$sth->execute(@bind_params);
3357	my $anonymisation_err = $dbh->err;
3358	my $rows_affected = $sth->rows; ### doublecheck row count return function
3359	return ($rows_affected, $anonymisation_err);
3360	}
3361
3362	=head2 SendCirculationAlert	3318	=head2 SendCirculationAlert
3363		3319
3364	Send out a C<check-in> or C<checkout> alert using the messaging system.	3320	Send out a C<check-in> or C<checkout> alert using the messaging system.

Lines 82-88 BEGIN { Link Here

(-)a/C4/Members.pm (-46 lines)
82		82
83	&GetBorrowersToExpunge	83	&GetBorrowersToExpunge
84	&GetBorrowersWhoHaveNeverBorrowed	84	&GetBorrowersWhoHaveNeverBorrowed
85	&GetBorrowersWithIssuesHistoryOlderThan
86		85
87	&GetUpcomingMembershipExpires	86	&GetUpcomingMembershipExpires
88		87
Lines 1555-1605 sub GetBorrowersWhoHaveNeverBorrowed { Link Here
1555	return \@results;	1554	return \@results;
1556	}	1555	}
1557		1556
1558	=head2 GetBorrowersWithIssuesHistoryOlderThan
1559
1560	$results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1561
1562	this function get all borrowers who has an issue history older than I<$date> given on input arg.
1563
1564	I<$result> is a ref to an array which all elements are a hashref.
1565	This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1566
1567	=cut
1568
1569	sub GetBorrowersWithIssuesHistoryOlderThan {
1570	my $dbh = C4::Context->dbh;
1571	my $date = shift \|\|POSIX::strftime("%Y-%m-%d",localtime());
1572	my $filterbranch = shift \|\|
1573	((C4::Context->preference('IndependentBranches')
1574	&& C4::Context->userenv
1575	&& !C4::Context->IsSuperLibrarian()
1576	&& C4::Context->userenv->{branch})
1577	? C4::Context->userenv->{branch}
1578	: "");
1579	my $query = "
1580	SELECT count(borrowernumber) as n,borrowernumber
1581	FROM old_issues
1582	WHERE returndate < ?
1583	AND borrowernumber IS NOT NULL
1584	";
1585	my @query_params;
1586	push @query_params, $date;
1587	if ($filterbranch){
1588	$query.=" AND branchcode = ?";
1589	push @query_params, $filterbranch;
1590	}
1591	$query.=" GROUP BY borrowernumber ";
1592	warn $query if $debug;
1593	my $sth = $dbh->prepare($query);
1594	$sth->execute(@query_params);
1595	my @results;
1596
1597	while ( my $data = $sth->fetchrow_hashref ) {
1598	push @results, $data;
1599	}
1600	return \@results;
1601	}
1602
1603	=head2 IssueSlip	1557	=head2 IssueSlip
1604		1558
1605	IssueSlip($branchcode, $borrowernumber, $quickslip)	1559	IssueSlip($branchcode, $borrowernumber, $quickslip)

Lines 37-46 use CGI qw ( -utf8 ); Link Here

(-)a/tools/cleanborrowers.pl (-14 / +11 lines)
37	use C4::Auth;	37	use C4::Auth;
38	use C4::Output;	38	use C4::Output;
39	use C4::Members; # GetBorrowersWhoHavexxxBorrowed.	39	use C4::Members; # GetBorrowersWhoHavexxxBorrowed.
40	use C4::Circulation; # AnonymiseIssueHistory.
41	use Koha::DateUtils qw( dt_from_string output_pref );	40	use Koha::DateUtils qw( dt_from_string output_pref );
42	use Koha::Patron::Categories;	41	use Koha::Patron::Categories;
43	use Date::Calc qw/Today Add_Delta_YM/;	42	use Date::Calc qw/Today Add_Delta_YM/;
		43	use Koha::Patrons;
44	use Koha::List::Patron;	44	use Koha::List::Patron;
45		45
46	my $cgi = new CGI;	46	my $cgi = new CGI;
Lines 105-123 if ( $step == 2 ) { Link Here
105	}	105	}
106	_skip_borrowers_with_nonzero_balance($patrons_to_delete);	106	_skip_borrowers_with_nonzero_balance($patrons_to_delete);
107		107
108	my $members_to_anonymize;	108	my $patrons_to_anonymize =
109	if ( $checkboxes{issue} ) {	109	$checkboxes{issue}
110	if ( $branch eq '*' ) {	110	? $branch eq '*'
111	$members_to_anonymize = GetBorrowersWithIssuesHistoryOlderThan($last_issue_date);	111	? Koha::Patrons->search_patrons_to_anonymise($last_issue_date)
112	} else {	112	: Koha::Patrons->search_patrons_to_anonymise( $last_issue_date, $branch )
113	$members_to_anonymize = GetBorrowersWithIssuesHistoryOlderThan($last_issue_date, $branch);	113	: undef;
114	}
115	}
116		114
117	$template->param(	115	$template->param(
118	patrons_to_delete => $patrons_to_delete,	116	patrons_to_delete => $patrons_to_delete,
119	patrons_to_anonymize => $members_to_anonymize,	117	patrons_to_anonymize => $patrons_to_anonymize,
120	patron_list_id => $patron_list_id	118	patron_list_id => $patron_list_id,
121	);	119	);
122	}	120	}
123		121
Lines 159-167 elsif ( $step == 3 ) { Link Here
159	# Anonymising all members	157	# Anonymising all members
160	if ($do_anonym) {	158	if ($do_anonym) {
161	#FIXME: anonymisation errors are not handled	159	#FIXME: anonymisation errors are not handled
162	($totalAno,my $anonymisation_error) = AnonymiseIssueHistory($last_issue_date);	160	my $rows = Koha::Patrons->search_patrons_to_anonymise( $last_issue_date )->anonymise_issue_history( $last_issue_date );
163	$template->param(	161	$template->param(
164	do_anonym => '1',	162	do_anonym => $rows,
165	);	163	);
166	}	164	}
167		165
168	-

Lines 1-6 Link Here

(-)a/Koha/Patrons.pm (-1 / +58 lines)
1	package Koha::Patrons;	1	package Koha::Patrons;
2		2
3	# Copyright ByWater Solutions 2014	3	# Copyright 2014 ByWater Solutions
		4	# Copyright 2016 Koha Development Team
4	#	5	#
5	# This file is part of Koha.	6	# This file is part of Koha.
6	#	7	#
Lines 22-27 use Modern::Perl; Link Here
22	use Carp;	23	use Carp;
23		24
24	use Koha::Database;	25	use Koha::Database;
		26	use Koha::DateUtils;
25		27
26	use Koha::Patron;	28	use Koha::Patron;
27		29
Lines 37-42 Koha::Patron - Koha Patron Object class Link Here
37		39
38	=cut	40	=cut
39		41
		42	=head3 search_patrons_to_anonymise
		43
		44	my $patrons = Koha::Patrons->search_patrons_to_anonymise( $date );
		45
		46	This method returns all patrons who has an issue history older than a given date.
		47
		48	=cut
		49
		50	sub search_patrons_to_anonymise {
		51	my ( $class, $older_than_date, $library ) = @_;
		52	$older_than_date = $older_than_date ? dt_from_string($older_than_date) : dt_from_string;
		53	$library \|\|=
		54	( C4::Context->preference('IndependentBranches') && C4::Context->userenv && !C4::Context->IsSuperLibrarian() && C4::Context->userenv->{branch} )
		55	? C4::Context->userenv->{branch}
		56	: undef;
		57
		58	my $dtf = Koha::Database->new->schema->storage->datetime_parser;
		59	my $rs = $class->search(
		60	{ returndate => { '<' => $dtf->format_datetime($older_than_date), },
		61	'old_issues.borrowernumber' => { 'not' => undef },
		62	privacy => { '<>' => 0 }, # Keep forever
		63	( $library ? ( 'old_issues.branchcode' => $library ) : () ),
		64	},
		65	{ join => ["old_issues"],
		66	group_by => 'borrowernumber'
		67	}
		68	);
		69	return Koha::Patrons->_new_from_dbic($rs);
		70	}
		71
		72	=head3 anonymise_issue_history
		73
		74	Koha::Patrons->search->anonymise_issue_history( $older_than_date );
		75
		76	Anonymise issue history (old_issues) for all patrons older than the given date.
		77	To make sure all the conditions are met, the caller has the responsability to
		78	call search_patrons_to_anonymise to filter the Koha::Patrons set
		79
		80	=cut
		81
		82	sub anonymise_issue_history {
		83	my ( $self, $older_than_date ) = @_;
		84
		85	return unless $older_than_date;
		86	$older_than_date = dt_from_string $older_than_date;
		87
		88	# The default of 0 does not work due to foreign key constraints
		89	# The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
		90	# Set it to undef (NULL)
		91	my $dtf = Koha::Database->new->schema->storage->datetime_parser;
		92	my $old_issues_to_anonymise = $self->search_related( 'old_issues', { returndate => { '<' => $dtf->format_datetime($older_than_date) } } );
		93	my $anonymous_patron = C4::Context->preference('AnonymousPatron') \|\| undef;
		94	$old_issues_to_anonymise->update( { 'old_issues.borrowernumber' => $anonymous_patron } );
		95	}
		96
40	=head3 type	97	=head3 type
41		98
42	=cut	99	=cut

Lines 21-27 use CGI qw ( -utf8 ); Link Here

(-)a/opac/opac-privacy.pl (-10 / +5 lines)
21		21
22	use C4::Auth; # checkauth, getborrowernumber.	22	use C4::Auth; # checkauth, getborrowernumber.
23	use C4::Context;	23	use C4::Context;
24	use C4::Circulation;
25	use C4::Members;	24	use C4::Members;
26	use C4::Output;	25	use C4::Output;
27	use Koha::Patrons;	26	use Koha::Patrons;
Lines 62-77 elsif ( $op eq "delete_record" ) { Link Here
62		61
63	# delete all reading records for items returned	62	# delete all reading records for items returned
64	# uses a hardcoded date ridiculously far in the future	63	# uses a hardcoded date ridiculously far in the future
65	my ( $rows, $err_history_not_deleted ) =
66	AnonymiseIssueHistory( '2999-12-12', $borrowernumber );
67		64
68	# confirm the user the deletion has been done	65	my $rows = eval {
69	if ( !$err_history_not_deleted ) {	66	Koha::Patrons->search({ 'me.borrowernumber' => $borrowernumber })->anonymise_issue_history( '2999-12-12' );
70	$template->param( 'deleted' => 1 );	67	};
71	}	68	$rows = $@ ? 0 : int($rows);
72	else {	69	$template->param( 'deleted' => $rows );
73	$template->param( 'err_history_not_deleted' => 1 );
74	}
75	}	70	}
76		71
77	# get borrower privacy ....	72	# get borrower privacy ....