Koha/ApiKey.pm

   1 package Koha::ApiKey;
   2
   3 # Copyright BibLibre 2015
   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 3 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
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25 use Koha::Exceptions;
  26
  27 use UUID;
  28
  29 use base qw(Koha::Object);
  30
  31 =head1 NAME
  32
  33 Koha::ApiKey - Koha API Key Object class
  34
  35 =head1 API
  36
  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     $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;
  54
  55     return $self->SUPER::store();
  56 }
  57
  58 =head2 Internal methods
  59
  60 =cut
  61
  62 =head3 _type
  63
  64 =cut
  65
  66 sub _type {
  67     return 'ApiKey';
  68 }
  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
  95 1;