lib/Onis/Data/Persistent.pm

   1 package Onis::Data::Persistent;
   2
   3 use strict;
   4 use warnings;
   5
   6 use Carp qw(confess);
   7
   8 =head1 NAME
   9
  10 Onis::Data::Persistent - Interface for storage backends
  11
  12 =head1 DESCRIPTION
  13
  14 Abstraction layer for modules that act as a backend and are able to store
  15 internal data for longer than one run..
  16
  17 =cut
  18
  19 use Onis::Config qw#get_config get_checksum#;
  20
  21 our $StoreModule = 'None';
  22
  23 =head1 CONFIGURATION OPTIONS
  24
  25 Since this is a B<interface> the options are very few. One, to be specific. See
  26 your favorite backend's documentation on it's options..
  27
  28 =over 4
  29
  30 =item B<storage_module>
  31
  32 Selects the storage module to use. Defaults to I<None> which is a dummy module
  33 that doesn't do anything with the data.. (Other than storing it internally..)
  34 Currently implemented options are:
  35
  36     None       (todo)
  37     Storable   (maybe)
  38     GDBM/SDBM  (todo)
  39     MySQL      (todo)
  40     PostgreSQL (maybe)
  41
  42 =back
  43
  44 =cut
  45
  46 if (get_config ('storage_module'))
  47 {
  48         $StoreModule = ucfirst (lc (get_config ('storage_module')));
  49 }
  50
  51 {
  52         my $mod_name = "Onis::Data::Persistent::$StoreModule";
  53
  54         eval qq(use $mod_name;);
  55
  56         if ($@)
  57         {
  58                 print STDERR $/, __FILE__, ": Could not load storage module ``$StoreModule''. Are you sure it exists?";
  59                 print STDERR $/, __FILE__, ": Error while loading was: $@";
  60                 exit (1);
  61         }
  62
  63         unshift (@Onis::Data::Persistent::ISA, $mod_name);
  64 }
  65
  66 return (1);
  67
  68 =head1 INTERFACE
  69
  70 The child-modules have to provide the following interface:
  71
  72 =over 4
  73
  74 =item B<Onis::Data::Persistent-E<gt>new> (I<$name>, I<$key_name>, I<@field_names>)
  75
  76 This is the constructor for the objects that will hold the data. Some modules
  77 may need a name for each field, and this is where plugins have to give the name
  78 of each field. This is particularly important for backends using relational
  79 databeses. I<$name> is merely a name for that variable or, in the database
  80 world - a table. The name must be unique for each calling method's namespace.
  81
  82 Since this is a constructor it returns an object. The object "knows" the folling methods:
  83
  84 =item B<$data-E<gt>get> (I<$key>)
  85
  86 Returns the data associated with the given I<$key> pair or an empty list if no
  87 data has been stored under this tupel before..
  88
  89 =item B<$data-E<gt>put> (I<$key>, I<@fields>)
  90
  91 Stores the given values in the data structure. How this is done is described
  92 below in L<another paragraph>. Doesn't return anything. The number of entries
  93 in I<@fields> has to match the number of entries in I<@field_names> when
  94 creating the object using B<new>.
  95
  96 =item B<$data-E<gt>keys> ([I<$field>, ...])
  97
  98 Returns a list of all the keys defined for this object. If one field is given
  99 the list will be sorted by that field's values, if more fields are given the
 100 list is sorted with the first field taking precedence over the others. If no
 101 field is supplied the order is undefined.
 102
 103 =back
 104
 105 =head1 INTERNALS
 106
 107 The B<put> and B<get> methods can be found in the
 108 B<Onis::Data::Persistent::None> module. Other modules are encouraged to inherit
 109 from that module, but don't need to. The data is stored as follows: The object
 110 that's returned to the caller is actually a hash with this layout:
 111
 112     %object =
 113     (
 114         data =>
 115         {
 116             key0 => [ qw(field0 field1 field2 ...) ],
 117             key1 => [ qw(field0 field1 field2 ...) ],
 118             key2 => [ qw(field0 field1 field2 ...) ],
 119             ...
 120         }
 121     );
 122
 123 The actual data is not directly stored under I<%object> so database backends
 124 can store metadata there (table name, credentials, whatever..).
 125
 126 =head1 FURTHER CONSIDERATIONS
 127
 128 Backend modules will probably read the entire data at startup and save
 129 everything at the end. Another strategy might be reading (at least trying to)
 130 an entry when it's first tried to B<get>..
 131
 132 =head1 AUTHOR
 133
 134 Florian octo Forster, L<octo@verplant.org>. Any comments welcome as long as I
 135 haven't started implementing this ;)
 136
 137 =cut