koha-dev.rot13.org Git - srvgit/blob - 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
   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 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22
  23 use Koha::Database;
  24 use Koha::Exceptions;
  25
  26 use UUID;
  27
  28 use base qw(Koha::Object);
  29
  30 =head1 NAME
  31
  32 Koha::ApiKey - Koha API Key Object class
  33
  34 =head1 API
  35
  36 =head2 Class methods
  37
  38 =head3 store
  39
  40     my $api_key = Koha::ApiKey->new({ patron_id => $patron_id })->store;
  41
  42 Overloaded I<store> method.
  43
  44 =cut
  45
  46 sub store {
  47     my ($self) = @_;
  48
  49     $self->client_id($self->_generate_unused_uuid('client_id'))
  50         unless $self->client_id;
  51     $self->secret($self->_generate_unused_uuid('secret'))
  52         unless $self->secret;
  53
  54     return $self->SUPER::store();
  55 }
  56
  57 =head2 Internal methods
  58
  59 =cut
  60
  61 =head3 _type
  62
  63 =cut
  64
  65 sub _type {
  66     return 'ApiKey';
  67 }
  68
  69 =head3 _generate_unused_uuid
  70
  71     my $string = $self->_generate_unused_uuid($column);
  72
  73 $column can be 'client_id' or 'secret'.
  74
  75 =cut
  76
  77 sub _generate_unused_uuid {
  78     my ($self, $column) = @_;
  79
  80     my ( $uuid, $uuidstring );
  81
  82     UUID::generate($uuid);
  83     UUID::unparse( $uuid, $uuidstring );
  84
  85     while ( Koha::ApiKeys->search({ $column => $uuidstring })->count > 0 ) {
  86         # Make sure $secret is unique
  87         UUID::generate($uuid);
  88         UUID::unparse( $uuid, $uuidstring );
  89     }
  90
  91     return $uuidstring;
  92 }
  93
  94 1;