lib/NonameTV/Factory.pm

   1 package NonameTV::Factory;
   2
   3 use strict;
   4
   5 =head1 NAME
   6
   7 NonameTV::Factory
   8
   9 =head1 DESCRIPTION
  10
  11 Create other NonameTV objects based on the available configuration.
  12
  13 =head1 METHODS
  14
  15 =over 4
  16
  17 =cut
  18
  19 BEGIN {
  20     use Exporter   ();
  21     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
  22
  23     @ISA         = qw(Exporter);
  24     @EXPORT      = qw( );
  25     %EXPORT_TAGS = ( );     # eg: TAG => [ qw!name1 name2! ],
  26     @EXPORT_OK   = qw/ CreateAugmenter
  27                        CreateDataStore CreateDataStoreDummy
  28                        CreateImporter CreateExporter CreateFileStore
  29                        InitHttpCache
  30                      /;
  31 }
  32 our @EXPORT_OK;
  33
  34 use NonameTV::Config qw/ReadConfig/;
  35
  36 =item CreateAugmenter( $name, $ds )
  37
  38 Create an augmenter from the configuration in $conf->{Augmenter}->{$name}
  39 and associate it with the NonameTV::DataStore in $ds.
  40
  41 Returns the newly created augmenter or dies if creation fails.
  42
  43 =cut
  44
  45 sub CreateAugmenter {
  46   my( $name, $ds ) = @_;
  47
  48   my $conf = ReadConfig();
  49
  50   if( not exists( $conf->{Augmenters}->{$name} ) ) {
  51     print STDERR "No such augmenter $name\n";
  52     exit 1;
  53   }
  54
  55   my $aug_data = $conf->{Augmenters}->{$name};
  56   $aug_data->{ConfigName} = $name;
  57
  58   my $aug_type = $aug_data->{Type};
  59
  60   if( not defined $aug_type ) {
  61     print STDERR "Augmenter $name has no Type-field\n";
  62     exit 1;
  63   }
  64
  65   my $aug = eval "use NonameTV::Augmenter::$aug_type;
  66                   NonameTV::Augmenter::${aug_type}->new( \$aug_data, \$ds );"
  67                       or die $@;
  68   return $aug;
  69 }
  70
  71 =item CreateImporter( $name, $ds )
  72
  73 Create an importer from the configuration in $conf->{Importer}->{$name}
  74 and associate it with the NonameTV::DataStore in $ds.
  75
  76 Returns the newly created importer or dies if creation fails.
  77
  78 =cut
  79
  80 sub CreateImporter {
  81   my( $name, $ds ) = @_;
  82
  83   my $conf = ReadConfig();
  84
  85   if( not exists( $conf->{Importers}->{$name} ) ) {
  86     print STDERR "No such importer $name\n";
  87     exit 1;
  88   }
  89
  90   my $imp_data = $conf->{Importers}->{$name};
  91   $imp_data->{ConfigName} = $name;
  92
  93   my $imp_type = $imp_data->{Type};
  94
  95   if( not defined $imp_type ) {
  96     print STDERR "Importer $name has no Type-field\n";
  97     exit 1;
  98   }
  99
 100   my $imp = eval "use NonameTV::Importer::$imp_type;
 101                   NonameTV::Importer::${imp_type}->new( \$imp_data, \$ds );"
 102                       or die $@;
 103   return $imp;
 104 }
 105
 106 =item CreateExporter( $name, $ds )
 107
 108 Create an exporter from the configuration in $conf->{Exporter}->{$name}
 109 and associate it with the NonameTV::DataStore in $ds.
 110
 111 Returns the newly created exporter or dies if creation fails.
 112
 113 =cut
 114
 115 sub CreateExporter {
 116   my( $name, $ds ) = @_;
 117
 118   my $conf = ReadConfig();
 119
 120   if( not exists( $conf->{Exporters}->{$name} ) ) {
 121     print STDERR "No such exporter $name\n";
 122     exit 1;
 123   }
 124
 125   my $exp_data = $conf->{Exporters}->{$name};
 126   my $exp_type = $exp_data->{Type};
 127
 128   my $exp = eval "use NonameTV::Exporter::$exp_type;
 129                   NonameTV::Exporter::${exp_type}->new( \$exp_data, \$ds );"
 130                       or die $@;
 131   return $exp;
 132 }
 133
 134 =item CreateFileStore( $importername )
 135
 136 Create a NonameTV::FileStore object that matches the configuration
 137 for an importer.
 138
 139 Returns the newly created filestore or dies if creation fails.
 140
 141 =cut
 142
 143 sub CreateFileStore {
 144   my( $importername ) = @_;
 145
 146   require NonameTV::FileStore;
 147
 148   my $conf = ReadConfig();
 149
 150   if( not exists( $conf->{Importers}->{$importername} ) ) {
 151     print STDERR "No such importer $importername\n";
 152     exit 1;
 153   }
 154
 155   my $path;
 156
 157   if( exists( $conf->{Importers}->{$importername}->{FileStore} ) ) {
 158     $path = $conf->{Importers}->{$importername}->{FileStore};
 159   }
 160   elsif( exists( $conf->{FileStore} ) ) {
 161     $path = $conf->{FileStore};
 162   }
 163   else {
 164     print STDERR "No FileStore found in configuration for " .
 165         "importer $importername.";
 166     exit 1;
 167   }
 168
 169   return NonameTV::FileStore->new( { Path => $path } );
 170 }
 171
 172 =item CreateDataStore
 173
 174 Create a NonameTV::DataStore from the configuration.
 175
 176 Returns the newly created datastore or dies if creation fails.
 177 If CreateDataStore is called more than once, the same DataStore object
 178 will be returned avery time.
 179
 180 =cut
 181
 182 my $ds;
 183
 184 sub CreateDataStore {
 185   return $ds if defined $ds;
 186
 187   my $conf = ReadConfig();
 188
 189   require NonameTV::DataStore;
 190   $ds = NonameTV::DataStore->new( $conf->{DataStore} );
 191
 192   return $ds;
 193 }
 194
 195 =item CreateDataStoreDummy
 196
 197 Create a dummy datastore (see NonameTV::DataStore::Dummy) from the
 198 configuration.
 199
 200 Returns the newly created datastore or dies if creation fails.
 201
 202 =cut
 203
 204 sub CreateDataStoreDummy {
 205   my $conf = ReadConfig();
 206
 207   require NonameTV::DataStore::Dummy;
 208   return NonameTV::DataStore::Dummy->new( $conf->{DataStore} );
 209 }
 210
 211 =item InitHttpCache
 212
 213 Initialize the HTTP::Cache::Transparent module from the configuration.
 214
 215 =cut
 216
 217 sub InitHttpCache {
 218   require HTTP::Cache::Transparent;
 219   my $conf = ReadConfig();
 220   HTTP::Cache::Transparent::init( $conf->{Cache} );
 221 }
 222
 223 1;
 224