Attachment #74255 for bug #20568

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

Lines 22-27 use Modern::Perl; Link Here

(-)a/Koha/ApiKey.pm (-3 / +52 lines)
22	use Carp;	22	use Carp;
23		23
24	use Koha::Database;	24	use Koha::Database;
		25	use Koha::Exceptions;
		26
		27	use UUID;
25		28
26	use base qw(Koha::Object);	29	use base qw(Koha::Object);
27		30
Lines 31-46 Koha::ApiKey - Koha API Key Object class Link Here
31		34
32	=head1 API	35	=head1 API
33		36
34	=head2 Class Methods	37	=head2 Class methods
		38
		39	=head3 store
		40
		41	my $api_key = Koha::ApiKey->new({ patron_id => $patron_id })->store;
		42
		43	Overloaded I<store> method.
		44
		45	=cut
		46
		47	sub store {
		48	my ($self) = @_;
		49
		50	my ( $uuid, $uuidstring );
		51
		52	$self->client_id($self->_generate_unused_uuid('client_id'));
		53	$self->secret($self->_generate_unused_uuid('secret'));
		54
		55	return $self->SUPER::store();
		56	}
		57
		58	=head2 Internal methods
35		59
36	=cut	60	=cut
37		61
38	=head3 type	62	=head3 _type
39		63
40	=cut	64	=cut
41		65
42	sub type {	66	sub _type {
43	return 'ApiKey';	67	return 'ApiKey';
44	}	68	}
45		69
		70	=head3 _generate_unused_uuid
		71
		72	my $string = $self->_generate_unused_uuid($column);
		73
		74	$column can be 'client_id' or 'secret'.
		75
		76	=cut
		77
		78	sub _generate_unused_uuid {
		79	my ($self, $column) = @_;
		80
		81	my ( $uuid, $uuidstring );
		82
		83	UUID::generate($uuid);
		84	UUID::unparse( $uuid, $uuidstring );
		85
		86	while ( Koha::ApiKeys->search({ $column => $uuidstring })->count > 0 ) {
		87	# Make sure $secret is unique
		88	UUID::generate($uuid);
		89	UUID::unparse( $uuid, $uuidstring );
		90	}
		91
		92	return $uuidstring;
		93	}
		94
46	1;	95	1;




use Carp;

use Koha::Database;
use Koha::ApiKey;
use Koha::Borrower;

use base qw(Koha::Objects);



=head1 API

=head2 Internal methods

=cut

=head3 _type

=cut

sub _type {
    return 'ApiKey';
}

=head3 object_class

=cut

sub object_class {
    return 'Koha::ApiKey';
}





=head1 ACCESSORS

=head2 id

  data_type: 'integer'
  is_auto_increment: 1
  is_nullable: 0

=head2 patron_id

  data_type: 'integer'
  is_foreign_key: 1
  is_nullable: 0

=head2 client_id

  data_type: 'varchar'
  is_nullable: 0
  size: 191

=head2 secret

  data_type: 'varchar'
  is_nullable: 0
  size: 191

=head2 description

  data_type: 'varchar'
  is_nullable: 0


=head2 active

  data_type: 'tinyint'
  default_value: 1
  is_nullable: 0

=cut

__PACKAGE__->add_columns(
  "id",
  { data_type => "integer", is_auto_increment => 1, is_nullable => 0 },
  "patron_id",
  { data_type => "integer", is_foreign_key => 1, is_nullable => 0 },
  "client_id",
  { data_type => "varchar", is_nullable => 0, size => 191 },
  "secret",
  { data_type => "varchar", is_nullable => 0, size => 191 },
  "description",
  { data_type => "varchar", is_nullable => 0, size => 255 },
  "active",
  { data_type => "tinyint", default_value => 1, is_nullable => 0 },
);

=head1 PRIMARY KEY

=over 4

=item * L</id>

=back

=cut

__PACKAGE__->set_primary_key("id");

=head1 UNIQUE CONSTRAINTS

=head2 C<client_id>

=over 4

=item * L</client_id>

=back

=cut

__PACKAGE__->add_unique_constraint("client_id", ["client_id"]);

=head2 C<secret>

=over 4

=item * L</secret>

=back

=cut

__PACKAGE__->add_unique_constraint("secret", ["secret"]);

=head1 RELATIONS

=head2 patron

Type: belongs_to


=cut

__PACKAGE__->belongs_to(
  "patron",
  "Koha::Schema::Result::Borrower",
  { borrowernumber => "patron_id" },
  { is_deferrable => 1, on_delete => "CASCADE", on_update => "CASCADE" },
);


# Created by DBIx::Class::Schema::Loader v0.07042 @ 2018-04-14 00:56:23
# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:b7AUAgl2SClXJ2lzPVV0FA

__PACKAGE__->add_columns(
    '+active' => { is_boolean => 1 }
);

# You can replace this text with custom code or comments, and it will be preserved on regeneration
1;




  { cascade_copy => 0, cascade_delete => 0 },
);

=head2 api_keys

Type: has_many

Related object: L<Koha::Schema::Result::ApiKey>

=cut

__PACKAGE__->has_many(
  "api_keys",
  "Koha::Schema::Result::ApiKey",
  { "foreign.patron_id" => "self.borrowernumber" },
  { cascade_copy => 0, cascade_delete => 0 },
);

=head2 aqbasketusers

Type: has_many

__PACKAGE__->many_to_many("ordernumbers", "aqorder_users", "ordernumber");


# Created by DBIx::Class::Schema::Loader v0.07042 @ 2018-04-11 19:53:27
# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:/vLIMxDv4RcJOqKj6Mfg6w

__PACKAGE__->belongs_to(
    "guarantor",




$DBversion = "XXX";
if(CheckVersion($DBversion)) {

    $dbh->do(q{
        DROP TABLE IF EXISTS api_keys;
    });

    $dbh->do(q{
        CREATE TABLE `api_keys` (
            `id`          INT(11) NOT NULL AUTO_INCREMENT,
            `patron_id`   INT(11) NOT NULL,
            `client_id`   VARCHAR(191) NOT NULL,
            `secret`      VARCHAR(191) NOT NULL,
            `description` VARCHAR(255) NOT NULL,
            `active`      TINYINT(1) DEFAULT 1 NOT NULL,
            PRIMARY KEY (`id`),
            UNIQUE KEY `client_id` (`client_id`),
            UNIQUE KEY `secret` (`secret`),
            KEY `patron_id` (`patron_id`),
            CONSTRAINT `api_keys_fk_patron_id`
              FOREIGN KEY (`patron_id`)
              REFERENCES `borrowers` (`borrowernumber`)
              ON DELETE CASCADE ON UPDATE CASCADE
        ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
    });

    print "Upgrade to $DBversion done (Bug 20568 - Add API key management interface for patrons)\n";
    SetVersion($DBversion);
}




/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;

--
-- Table structure for table api_keys
--

DROP TABLE IF EXISTS api_keys;
CREATE TABLE api_keys (
    borrowernumber int(11) NOT NULL, -- foreign key to the borrowers table
    api_key VARCHAR(255) NOT NULL, -- API key used for API authentication
    active int(1) DEFAULT 1, -- 0 means this API key is revoked
    PRIMARY KEY (borrowernumber, api_key),
    CONSTRAINT api_keys_fk_borrowernumber
      FOREIGN KEY (borrowernumber)
      REFERENCES borrowers (borrowernumber)
      ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

--
-- Table structure for table `auth_header`
--

  CONSTRAINT borrower_sync_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

--
-- Table structure for table api_keys
--

DROP TABLE IF EXISTS `api_keys`;
CREATE TABLE `api_keys` (
    `id`          INT(11) NOT NULL AUTO_INCREMENT, -- API key internal identifier
    `patron_id`   INT(11) NOT NULL,                -- Foreign key to the borrowers table
    `client_id`   VARCHAR(191) NOT NULL,           -- API client ID
    `secret`      VARCHAR(191) NOT NULL,           -- API client secret used for API authentication
    `description` VARCHAR(255) NOT NULL,           -- API client description
    `active`      TINYINT(1) DEFAULT 1 NOT NULL,   -- 0 means this API key is revoked
    PRIMARY KEY (`id`),
    KEY `patron_id` (`patron_id`),
    UNIQUE KEY `client_id` (`client_id`),
    UNIQUE KEY `secret` (`secret`),
    CONSTRAINT `api_keys_fk_patron_id`
      FOREIGN KEY (`patron_id`)
      REFERENCES `borrowers` (`borrowernumber`)
      ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

--
-- Table structure for table `issues`
--

Lines 59-68 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/includes/members-toolbar.inc (-3 / +2 lines)
59	[% IF CAN_user_borrowers_edit_borrowers && useDischarge %]	59	[% IF CAN_user_borrowers_edit_borrowers && useDischarge %]
60	<li><a href="/cgi-bin/koha/members/discharge.pl?borrowernumber=[% patron.borrowernumber %]">Discharge</a></li>	60	<li><a href="/cgi-bin/koha/members/discharge.pl?borrowernumber=[% patron.borrowernumber %]">Discharge</a></li>
61	[% END %]	61	[% END %]
62	[% IF CAN_user_borrowers_edit_borrowers %]
63		62
64	[% IF ( CAN_user_borrowers ) %]	63	[% IF CAN_user_borrowers_edit_borrowers %]
65	<li><a id="apikeys" href="/cgi-bin/koha/members/apikeys.pl?borrowernumber=[% borrowernumber %]">Manage API keys</a></li>	64	<li><a id="apikeys" href="/cgi-bin/koha/members/apikeys.pl?patron_id=[% borrowernumber %]">Manage API keys</a></li>
66	[% ELSE %]	65	[% ELSE %]
67	<li class="disabled"><a data-toggle="tooltip" data-placement="left" title="You are not authorized to manage API keys" id="apikeys" href="#">Manage API keys</a></li>	66	<li class="disabled"><a data-toggle="tooltip" data-placement="left" title="You are not authorized to manage API keys" id="apikeys" href="#">Manage API keys</a></li>
68	[% END %]	67	[% END %]

Lines 24-38 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/members/apikeys.tt (-8 / +19 lines)
24	<h1>API keys for [% INCLUDE 'patron-title.inc' %]</h1>	24	<h1>API keys for [% INCLUDE 'patron-title.inc' %]</h1>
25	<div>	25	<div>
26	<form action="/cgi-bin/koha/members/apikeys.pl" method="post">	26	<form action="/cgi-bin/koha/members/apikeys.pl" method="post">
27	<input type="hidden" name="borrowernumber" value="[% borrowernumber %]">	27	<input type="hidden" name="patron_id" value="[% patron.id %]">
28	<input type="hidden" name="op" value="generate">	28	<input type="hidden" name="op" value="generate">
29	<input type="submit" value="Generate new key">	29	<label for="description">Description: </label>
		30	<input type="text" name="description">
		31	<button class="btn btn-default btn-sm" type="submit"><i class="fa fa-plus"></i> Generate a new key</span></button>
30	</form>	32	</form>
31	</div>	33	</div>
32	[% IF api_keys.size > 0 %]	34
		35	<br/>
		36
		37	<div id="keys">
		38	[% IF api_keys && api_keys.size > 0 %]
33	<table>	39	<table>
34	<thead>	40	<thead>
35	<tr>	41	<tr>
		42	<th>Description</th>
36	<th>Key</th>	43	<th>Key</th>
37	<th>Active</th>	44	<th>Active</th>
38	<th>Actions</th>	45	<th>Actions</th>
Lines 41-58 Link Here
41	<tbody>	48	<tbody>
42	[% FOREACH key IN api_keys %]	49	[% FOREACH key IN api_keys %]
43	<tr>	50	<tr>
44	<td>[% key.api_key %]</td>	51	<td>[% key.description %]</td>
		52	<td>[% key.value %]</td>
45	<td>[% IF key.active %]Yes[% ELSE %]No[% END %]</td>	53	<td>[% IF key.active %]Yes[% ELSE %]No[% END %]</td>
46	<td>	54	<td>
47	<form action="/cgi-bin/koha/members/apikeys.pl" method="post">	55	<form action="/cgi-bin/koha/members/apikeys.pl" method="post">
48	<input type="hidden" name="borrowernumber" value="[% borrowernumber %]">	56	<input type="hidden" name="patron_id" value="[% patron.id %]">
49	<input type="hidden" name="key" value="[% key.api_key %]">	57	<input type="hidden" name="key" value="[% key.value %]">
50	<input type="hidden" name="op" value="delete">	58	<input type="hidden" name="op" value="delete">
51	<input type="submit" value="Delete">	59	<input type="submit" value="Delete">
52	</form>	60	</form>
53	<form action="/cgi-bin/koha/members/apikeys.pl" method="post">	61	<form action="/cgi-bin/koha/members/apikeys.pl" method="post">
54	<input type="hidden" name="borrowernumber" value="[% borrowernumber %]">	62	<input type="hidden" name="patron_id" value="[% patron.id %]">
55	<input type="hidden" name="key" value="[% key.api_key %]">	63	<input type="hidden" name="key" value="[% key.value %]">
56	[% IF key.active %]	64	[% IF key.active %]
57	<input type="hidden" name="op" value="revoke">	65	<input type="hidden" name="op" value="revoke">
58	<input type="submit" value="Revoke">	66	<input type="submit" value="Revoke">
Lines 66-72 Link Here
66	[% END %]	74	[% END %]
67	</tbody>	75	</tbody>
68	</table>	76	</table>
		77	[% ELSE %]
		78	<span class="warn">No keys defined for the current patron.</span>
69	[% END %]	79	[% END %]
		80	</div>
70	</div>	81	</div>
71	</div>	82	</div>
72	<div class="yui-b">	83	<div class="yui-b">




#!/usr/bin/env perl

# Copyright 2015 BibLibre
#
# This file is part of Koha.
#
# Copyright 2015 BibLibre
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

use Modern::Perl;

use CGI;
use String::Random;

use C4::Auth;
use C4::Members;
use C4::Output;

use Koha::ApiKeys;
use Koha::Patrons;

my $cgi = new CGI;

my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
    {   template_name   => 'members/apikeys.tt',
        query           => $cgi,
        type            => 'intranet',
        authnotrequired => 0,
        flagsrequired   => { borrowers => 1 },
    }
);

my $patron;
my $patron_id = $cgi->param('patron_id') // '';
my $api_key   = $cgi->param('key')       // '';

$patron = Koha::Patrons->find($patron_id) if $patron_id;

if ( not defined $patron ) {

    # patron_id invalid -> exit
    print $cgi->redirect("/cgi-bin/koha/errors/404.pl"); # escape early
    exit;
}

my $borrowernumber = $cgi->param('borrowernumber');
my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
my $op = $cgi->param('op');

if ($op) {
    if ( $op eq 'generate' ) {
        my $description = $cgi->param('description') // '';
        my $api_key = Koha::ApiKey->new(
            {   patron_id   => $patron_id,
                description => $description
            }
        );
        $api_key->store;
        print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
        exit;
    }

    if ( $op eq 'delete' ) {
        my $api_key = $cgi->param('key');
        my $key = Koha::ApiKeys->find({ patron_id => $patron_id, value => $api_key });
        if ($key) {
            $key->delete;
        }
        print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
        exit;
    }

    if ( $op eq 'revoke' ) {
        my $api_key = $cgi->param('key');
        my $key = Koha::ApiKeys->find({ patron_id => $patron_id, value => $api_key });
        if ($key) {
            $key->active(0);
            $key->store;
        }
        print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
        exit;
    }

    if ( $op eq 'activate' ) {
        my $api_key = $cgi->param('key');
        my $key = Koha::ApiKeys->find({ patron_id => $patron_id, value => $api_key });
        if ($key) {
            $key->active(1);
            $key->store;
        }
        print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
        exit;
    }
}

my @api_keys = Koha::ApiKeys->search({ patron_id => $patron_id });

$template->param(
    api_keys => \@api_keys,
    patron   => $patron
    borrowernumber => $borrowernumber,
);

output_html_with_http_headers $cgi, $cookie, $template->output;
- 

Return to bug 20568

Lines 710-715 __PACKAGE__->has_many( Link Here

(-)a/Koha/Schema/Result/Borrower.pm (-2 / +17 lines)
710	{ cascade_copy => 0, cascade_delete => 0 },	710	{ cascade_copy => 0, cascade_delete => 0 },
711	);	711	);
712		712
		713	=head2 api_keys
		714
		715	Type: has_many
		716
		717	Related object: L<Koha::Schema::Result::ApiKey>
		718
		719	=cut
		720
		721	__PACKAGE__->has_many(
		722	"api_keys",
		723	"Koha::Schema::Result::ApiKey",
		724	{ "foreign.patron_id" => "self.borrowernumber" },
		725	{ cascade_copy => 0, cascade_delete => 0 },
		726	);
		727
713	=head2 aqbasketusers	728	=head2 aqbasketusers
714		729
715	Type: has_many	730	Type: has_many
Lines 1386-1393 Composing rels: L</aqorder_users> -> ordernumber Link Here
1386	__PACKAGE__->many_to_many("ordernumbers", "aqorder_users", "ordernumber");	1401	__PACKAGE__->many_to_many("ordernumbers", "aqorder_users", "ordernumber");
1387		1402
1388		1403
1389	# Created by DBIx::Class::Schema::Loader v0.07042 @ 2018-02-16 17:54:53	1404	# Created by DBIx::Class::Schema::Loader v0.07042 @ 2018-04-11 19:53:27
1390	# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:wM40W+toV8ca5LFwinkHxA	1405	# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:/vLIMxDv4RcJOqKj6Mfg6w
1391		1406
1392	__PACKAGE__->belongs_to(	1407	__PACKAGE__->belongs_to(
1393	"guarantor",	1408	"guarantor",

Lines 22-29 use Modern::Perl; Link Here

(-)a/Koha/ApiKeys.pm (-5 / +8 lines)
22	use Carp;	22	use Carp;
23		23
24	use Koha::Database;	24	use Koha::Database;
25		25	use Koha::ApiKey;
26	use Koha::Borrower;
27		26
28	use base qw(Koha::Objects);	27	use base qw(Koha::Objects);
29		28
Lines 33-50 Koha::ApiKeys - Koha API Keys Object class Link Here
33		32
34	=head1 API	33	=head1 API
35		34
36	=head2 Class Methods	35	=head2 Internal methods
37		36
38	=cut	37	=cut
39		38
40	=head3 type	39	=head3 _type
41		40
42	=cut	41	=cut
43		42
44	sub type {	43	sub _type {
45	return 'ApiKey';	44	return 'ApiKey';
46	}	45	}
47		46
		47	=head3 object_class
		48
		49	=cut
		50
48	sub object_class {	51	sub object_class {
49	return 'Koha::ApiKey';	52	return 'Koha::ApiKey';
50	}	53	}

Lines 23-35 __PACKAGE__->table("api_keys"); Link Here

(-)a/Koha/Schema/Result/ApiKey.pm (-15 / +66 lines)
23		23
24	=head1 ACCESSORS	24	=head1 ACCESSORS
25		25
26	=head2 borrowernumber	26	=head2 id
		27
		28	data_type: 'integer'
		29	is_auto_increment: 1
		30	is_nullable: 0
		31
		32	=head2 patron_id
27		33
28	data_type: 'integer'	34	data_type: 'integer'
29	is_foreign_key: 1	35	is_foreign_key: 1
30	is_nullable: 0	36	is_nullable: 0
31		37
32	=head2 api_key	38	=head2 client_id
		39
		40	data_type: 'varchar'
		41	is_nullable: 0
		42	size: 191
		43
		44	=head2 secret
		45
		46	data_type: 'varchar'
		47	is_nullable: 0
		48	size: 191
		49
		50	=head2 description
33		51
34	data_type: 'varchar'	52	data_type: 'varchar'
35	is_nullable: 0	53	is_nullable: 0
Lines 37-74 __PACKAGE__->table("api_keys"); Link Here
37		55
38	=head2 active	56	=head2 active
39		57
40	data_type: 'integer'	58	data_type: 'tinyint'
41	default_value: 1	59	default_value: 1
42	is_nullable: 1	60	is_nullable: 0
43		61
44	=cut	62	=cut
45		63
46	__PACKAGE__->add_columns(	64	__PACKAGE__->add_columns(
47	"borrowernumber",	65	"id",
		66	{ data_type => "integer", is_auto_increment => 1, is_nullable => 0 },
		67	"patron_id",
48	{ data_type => "integer", is_foreign_key => 1, is_nullable => 0 },	68	{ data_type => "integer", is_foreign_key => 1, is_nullable => 0 },
49	"api_key",	69	"client_id",
		70	{ data_type => "varchar", is_nullable => 0, size => 191 },
		71	"secret",
		72	{ data_type => "varchar", is_nullable => 0, size => 191 },
		73	"description",
50	{ data_type => "varchar", is_nullable => 0, size => 255 },	74	{ data_type => "varchar", is_nullable => 0, size => 255 },
51	"active",	75	"active",
52	{ data_type => "integer", default_value => 1, is_nullable => 1 },	76	{ data_type => "tinyint", default_value => 1, is_nullable => 0 },
53	);	77	);
54		78
55	=head1 PRIMARY KEY	79	=head1 PRIMARY KEY
56		80
57	=over 4	81	=over 4
58		82
59	=item * L</borrowernumber>	83	=item * L</id>
		84
		85	=back
		86
		87	=cut
		88
		89	__PACKAGE__->set_primary_key("id");
		90
		91	=head1 UNIQUE CONSTRAINTS
		92
		93	=head2 C<client_id>
		94
		95	=over 4
		96
		97	=item * L</client_id>
60		98
61	=item * L</api_key>	99	=back
		100
		101	=cut
		102
		103	__PACKAGE__->add_unique_constraint("client_id", ["client_id"]);
		104
		105	=head2 C<secret>
		106
		107	=over 4
		108
		109	=item * L</secret>
62		110
63	=back	111	=back
64		112
65	=cut	113	=cut
66		114
67	__PACKAGE__->set_primary_key("borrowernumber", "api_key");	115	__PACKAGE__->add_unique_constraint("secret", ["secret"]);
68		116
69	=head1 RELATIONS	117	=head1 RELATIONS
70		118
71	=head2 borrowernumber	119	=head2 patron
72		120
73	Type: belongs_to	121	Type: belongs_to
74		122
Lines 77-92 Related object: L<Koha::Schema::Result::Borrower> Link Here
77	=cut	125	=cut
78		126
79	__PACKAGE__->belongs_to(	127	__PACKAGE__->belongs_to(
80	"borrowernumber",	128	"patron",
81	"Koha::Schema::Result::Borrower",	129	"Koha::Schema::Result::Borrower",
82	{ borrowernumber => "borrowernumber" },	130	{ borrowernumber => "patron_id" },
83	{ is_deferrable => 1, on_delete => "CASCADE", on_update => "CASCADE" },	131	{ is_deferrable => 1, on_delete => "CASCADE", on_update => "CASCADE" },
84	);	132	);
85		133
86		134
87	# Created by DBIx::Class::Schema::Loader v0.07025 @ 2015-03-24 07:35:30	135	# Created by DBIx::Class::Schema::Loader v0.07042 @ 2018-04-14 00:56:23
88	# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:dvujXVM5Vfu3SA2UfiVPtw	136	# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:b7AUAgl2SClXJ2lzPVV0FA
89		137
		138	__PACKAGE__->add_columns(
		139	'+active' => { is_boolean => 1 }
		140	);
90		141
91	# You can replace this text with custom code or comments, and it will be preserved on regeneration	142	# You can replace this text with custom code or comments, and it will be preserved on regeneration
92	1;	143	1;

Line 0 Link Here

(-)a/installer/data/mysql/atomicupdate/bug_20568_api_keys.perl (+29 lines)
	1	$DBversion = "XXX";
	2	if(CheckVersion($DBversion)) {
	3
	4	$dbh->do(q{
	5	DROP TABLE IF EXISTS api_keys;
	6	});
	7
	8	$dbh->do(q{
	9	CREATE TABLE `api_keys` (
	10	`id` INT(11) NOT NULL AUTO_INCREMENT,
	11	`patron_id` INT(11) NOT NULL,
	12	`client_id` VARCHAR(191) NOT NULL,
	13	`secret` VARCHAR(191) NOT NULL,
	14	`description` VARCHAR(255) NOT NULL,
	15	`active` TINYINT(1) DEFAULT 1 NOT NULL,
	16	PRIMARY KEY (`id`),
	17	UNIQUE KEY `client_id` (`client_id`),
	18	UNIQUE KEY `secret` (`secret`),
	19	KEY `patron_id` (`patron_id`),
	20	CONSTRAINT `api_keys_fk_patron_id`
	21	FOREIGN KEY (`patron_id`)
	22	REFERENCES `borrowers` (`borrowernumber`)
	23	ON DELETE CASCADE ON UPDATE CASCADE
	24	) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
	25	});
	26
	27	print "Upgrade to $DBversion done (Bug 20568 - Add API key management interface for patrons)\n";
	28	SetVersion($DBversion);
	29	}

Lines 15-36 Link Here

(-)a/installer/data/mysql/kohastructure.sql (-16 / +22 lines)
15	/!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' /;	15	/!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' /;
16	/!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 /;	16	/!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 /;
17		17
18	--
19	-- Table structure for table api_keys
20	--
21
22	DROP TABLE IF EXISTS api_keys;
23	CREATE TABLE api_keys (
24	borrowernumber int(11) NOT NULL, -- foreign key to the borrowers table
25	api_key VARCHAR(255) NOT NULL, -- API key used for API authentication
26	active int(1) DEFAULT 1, -- 0 means this API key is revoked
27	PRIMARY KEY (borrowernumber, api_key),
28	CONSTRAINT api_keys_fk_borrowernumber
29	FOREIGN KEY (borrowernumber)
30	REFERENCES borrowers (borrowernumber)
31	ON DELETE CASCADE ON UPDATE CASCADE
32	) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
33
34	--	18	--
35	-- Table structure for table `auth_header`	19	-- Table structure for table `auth_header`
36	--	20	--
Lines 1729-1734 CREATE TABLE borrower_sync ( Link Here
1729	CONSTRAINT borrower_sync_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE	1713	CONSTRAINT borrower_sync_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE
1730	) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;	1714	) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1731		1715
		1716	--
		1717	-- Table structure for table api_keys
		1718	--
		1719
		1720	DROP TABLE IF EXISTS `api_keys`;
		1721	CREATE TABLE `api_keys` (
		1722	`id` INT(11) NOT NULL AUTO_INCREMENT, -- API key internal identifier
		1723	`patron_id` INT(11) NOT NULL, -- Foreign key to the borrowers table
		1724	`client_id` VARCHAR(191) NOT NULL, -- API client ID
		1725	`secret` VARCHAR(191) NOT NULL, -- API client secret used for API authentication
		1726	`description` VARCHAR(255) NOT NULL, -- API client description
		1727	`active` TINYINT(1) DEFAULT 1 NOT NULL, -- 0 means this API key is revoked
		1728	PRIMARY KEY (`id`),
		1729	KEY `patron_id` (`patron_id`),
		1730	UNIQUE KEY `client_id` (`client_id`),
		1731	UNIQUE KEY `secret` (`secret`),
		1732	CONSTRAINT `api_keys_fk_patron_id`
		1733	FOREIGN KEY (`patron_id`)
		1734	REFERENCES `borrowers` (`borrowernumber`)
		1735	ON DELETE CASCADE ON UPDATE CASCADE
		1736	) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
		1737
1732	--	1738	--
1733	-- Table structure for table `issues`	1739	-- Table structure for table `issues`
1734	--	1740	--

Lines 1-96 Link Here

(-)a/members/apikeys.pl (-54 / +66 lines)
1	#!/usr/bin/env perl	1	#!/usr/bin/env perl
2		2
3	# Copyright 2015 BibLibre
4	#
5	# This file is part of Koha.	3	# This file is part of Koha.
6	#	4	#
7	# Koha is free software; you can redistribute it and/or modify it under the	5	# Copyright 2015 BibLibre
8	# terms of the GNU General Public License as published by the Free Software	6	#
9	# Foundation; either version 2 of the License, or (at your option) any later	7	# Koha is free software; you can redistribute it and/or modify it
10	# version.	8	# under the terms of the GNU General Public License as published by
		9	# the Free Software Foundation; either version 3 of the License, or
		10	# (at your option) any later version.
11	#	11	#
12	# Koha is distributed in the hope that it will be useful, but WITHOUT ANY	12	# Koha is distributed in the hope that it will be useful, but
13	# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR	13	# WITHOUT ANY WARRANTY; without even the implied warranty of
14	# A PARTICULAR PURPOSE. See the GNU General Public License for more details.	14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		15	# GNU General Public License for more details.
15	#	16	#
16	# You should have received a copy of the GNU General Public License along	17	# You should have received a copy of the GNU General Public License
17	# with Koha; if not, write to the Free Software Foundation, Inc.,	18	# along with Koha; if not, see <http://www.gnu.org/licenses>.
18	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19		19
20	use Modern::Perl;	20	use Modern::Perl;
21		21
22	use CGI;	22	use CGI;
23	use String::Random;
24		23
25	use C4::Auth;	24	use C4::Auth;
26	use C4::Members;
27	use C4::Output;	25	use C4::Output;
		26
28	use Koha::ApiKeys;	27	use Koha::ApiKeys;
29	use Koha::ApiKey;	28	use Koha::Patrons;
30		29
31	my $cgi = new CGI;	30	my $cgi = new CGI;
32		31
33	my ($template, $loggedinuser, $cookie) = get_template_and_user({	32	my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
34	template_name => 'members/apikeys.tt',	33	{ template_name => 'members/apikeys.tt',
35	query => $cgi,	34	query => $cgi,
36	type => 'intranet',	35	type => 'intranet',
37	authnotrequired => 0,	36	authnotrequired => 0,
38	flagsrequired => {borrowers => 1},	37	flagsrequired => { borrowers => 1 },
39	});	38	}
		39	);
		40
		41	my $patron;
		42	my $patron_id = $cgi->param('patron_id') // '';
		43	my $api_key = $cgi->param('key') // '';
		44
		45	$patron = Koha::Patrons->find($patron_id) if $patron_id;
		46
		47	if ( not defined $patron ) {
		48
		49	# patron_id invalid -> exit
		50	print $cgi->redirect("/cgi-bin/koha/errors/404.pl"); # escape early
		51	exit;
		52	}
40		53
41	my $borrowernumber = $cgi->param('borrowernumber');
42	my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
43	my $op = $cgi->param('op');	54	my $op = $cgi->param('op');
44		55
45	if ($op) {	56	if ($op) {
46	if ($op eq 'generate') {	57	if ( $op eq 'generate' ) {
47	my $apikey = new Koha::ApiKey;	58	my $description = $cgi->param('description') // '';
48	$apikey->borrowernumber($borrowernumber);	59	my $api_key = Koha::ApiKey->new(
49	$apikey->api_key(String::Random->new->randregex('[a-zA-Z0-9]{32}'));	60	{ patron_id => $patron_id,
50	$apikey->store;	61	description => $description
51	print $cgi->redirect('/cgi-bin/koha/members/apikeys.pl?borrowernumber=' . $borrowernumber);	62	}
		63	);
		64	$api_key->store;
		65	print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
52	exit;	66	exit;
53	}	67	}
54		68
55	if ($op eq 'delete') {	69	if ( $op eq 'delete' ) {
56	my $key = $cgi->param('key');	70	my $api_key = $cgi->param('key');
57	my $api_key = Koha::ApiKeys->find({borrowernumber => $borrowernumber, api_key => $key});	71	my $key = Koha::ApiKeys->find({ patron_id => $patron_id, value => $api_key });
58	if ($api_key) {	72	if ($key) {
59	$api_key->delete;	73	$key->delete;
60	}	74	}
61	print $cgi->redirect('/cgi-bin/koha/members/apikeys.pl?borrowernumber=' . $borrowernumber);	75	print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
62	exit;	76	exit;
63	}	77	}
64		78
65	if ($op eq 'revoke') {	79	if ( $op eq 'revoke' ) {
66	my $key = $cgi->param('key');	80	my $api_key = $cgi->param('key');
67	my $api_key = Koha::ApiKeys->find({borrowernumber => $borrowernumber, api_key => $key});	81	my $key = Koha::ApiKeys->find({ patron_id => $patron_id, value => $api_key });
68	if ($api_key) {	82	if ($key) {
69	$api_key->active(0);	83	$key->active(0);
70	$api_key->store;	84	$key->store;
71	}	85	}
72	print $cgi->redirect('/cgi-bin/koha/members/apikeys.pl?borrowernumber=' . $borrowernumber);	86	print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
73	exit;	87	exit;
74	}	88	}
75		89
76	if ($op eq 'activate') {	90	if ( $op eq 'activate' ) {
77	my $key = $cgi->param('key');	91	my $api_key = $cgi->param('key');
78	my $api_key = Koha::ApiKeys->find({borrowernumber => $borrowernumber, api_key => $key});	92	my $key = Koha::ApiKeys->find({ patron_id => $patron_id, value => $api_key });
79	if ($api_key) {	93	if ($key) {
80	$api_key->active(1);	94	$key->active(1);
81	$api_key->store;	95	$key->store;
82	}	96	}
83	print $cgi->redirect('/cgi-bin/koha/members/apikeys.pl?borrowernumber=' . $borrowernumber);	97	print $cgi->redirect( '/cgi-bin/koha/members/apikeys.pl?patron_id=' . $patron_id );
84	exit;	98	exit;
85	}	99	}
86	}	100	}
87		101
88	my @api_keys = Koha::ApiKeys->search({borrowernumber => $borrowernumber});	102	my @api_keys = Koha::ApiKeys->search({ patron_id => $patron_id });
89		103
90	$template->param(	104	$template->param(
91	api_keys => \@api_keys,	105	api_keys => \@api_keys,
92	borrower => $borrower,	106	patron => $patron
93	borrowernumber => $borrowernumber,
94	);	107	);
95		108
96	output_html_with_http_headers $cgi, $cookie, $template->output;	109	output_html_with_http_headers $cgi, $cookie, $template->output;
97	-