Bug 21783: Reindent admin/columns_settings.tt
[koha.git] / Koha / ApiKey.pm
blob14519d7a359085eb60d8279d93058611ddb6e5d2
1 package Koha::ApiKey;
3 # Copyright BibLibre 2015
5 # This file is part of Koha.
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 3 of the License, or (at your option) any later
10 # version.
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.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 use Modern::Perl;
22 use Carp;
24 use Koha::Database;
25 use Koha::Exceptions;
27 use UUID;
29 use base qw(Koha::Object);
31 =head1 NAME
33 Koha::ApiKey - Koha API Key Object class
35 =head1 API
37 =head2 Class methods
39 =head3 store
41 my $api_key = Koha::ApiKey->new({ patron_id => $patron_id })->store;
43 Overloaded I<store> method.
45 =cut
47 sub store {
48 my ($self) = @_;
50 $self->client_id($self->_generate_unused_uuid('client_id'))
51 unless $self->client_id;
52 $self->secret($self->_generate_unused_uuid('secret'))
53 unless $self->secret;
55 return $self->SUPER::store();
58 =head2 Internal methods
60 =cut
62 =head3 _type
64 =cut
66 sub _type {
67 return 'ApiKey';
70 =head3 _generate_unused_uuid
72 my $string = $self->_generate_unused_uuid($column);
74 $column can be 'client_id' or 'secret'.
76 =cut
78 sub _generate_unused_uuid {
79 my ($self, $column) = @_;
81 my ( $uuid, $uuidstring );
83 UUID::generate($uuid);
84 UUID::unparse( $uuid, $uuidstring );
86 while ( Koha::ApiKeys->search({ $column => $uuidstring })->count > 0 ) {
87 # Make sure $secret is unique
88 UUID::generate($uuid);
89 UUID::unparse( $uuid, $uuidstring );
92 return $uuidstring;