SL/DB/Helper/Mappings.pm

   1 package SL::DB::Helper::Mappings;
   2
   3 use utf8;
   4 use strict;
   5
   6 use SL::Util qw(camelify);
   7
   8 require Exporter;
   9 our @ISA       = qw(Exporter);
  10 our @EXPORT_OK = qw(get_table_for_package get_package_for_table get_package_names);
  11
  12 # these will not be managed as Rose::DB models, because they are not normalized,
  13 # significant changes are needed to get them done, or they were done by CRM.
  14 my @kivitendo_blacklist_permanent = qw(
  15   leads
  16 );
  17
  18 # these are not managed _yet_, but will hopefully at some point.
  19 # if you are confident that one of these works, remove it here.
  20 my @kivitendo_blacklist_temp = qw(
  21 );
  22
  23 # tables created by crm module
  24 my @crm_blacklist = qw(
  25   blz_data
  26   bundesland
  27   contmasch
  28   contract
  29   crm
  30   crmdefaults
  31   crmemployee
  32   custmsg
  33   docfelder
  34   documents
  35   documenttotc
  36   docvorlage
  37   extra_felder
  38   geodb_changelog
  39   geodb_coordinates
  40   geodb_floatdata
  41   geodb_hierarchies
  42   geodb_intdata
  43   geodb_locations
  44   geodb_textdata
  45   geodb_type_names
  46   grpusr
  47   gruppenname
  48   history
  49   labels
  50   labeltxt
  51   mailvorlage
  52   maschine
  53   maschmat
  54   opport_status
  55   opportunity
  56   postit
  57   repauftrag
  58   telcall
  59   telcallhistory
  60   telnr
  61   tempcsvdata
  62   termdate
  63   termincat
  64   termine
  65   terminmember
  66   timetrack
  67   tt_event
  68   tt_parts
  69   wiedervorlage
  70   wissencategorie
  71   wissencontent
  72 );
  73
  74 # tables created by cash register
  75 my @cash_register_blacklist = qw(
  76 ekartikel ekbon ekkunde ektext erptasten
  77 );
  78
  79 my @kivitendo_blacklist = (@kivitendo_blacklist_permanent, @kivitendo_blacklist_temp, @crm_blacklist, @cash_register_blacklist);
  80
  81 # map table names to their models.
  82 # unlike rails we have no singular<->plural magic.
  83 # remeber: tables should be named as the plural of the model name.
  84 my %kivitendo_package_names = (
  85   # TABLE                           # MODEL (given in C style)
  86   acc_trans                      => 'acc_transaction',
  87   audittrail                     => 'audit_trail',
  88   'auth.clients'                 => 'auth_client',
  89   'auth.clients_users'           => 'auth_client_user',
  90   'auth.clients_groups'          => 'auth_client_group',
  91   'auth.group'                   => 'auth_group',
  92   'auth.group_rights'            => 'auth_group_right',
  93   'auth.user'                    => 'auth_user',
  94   'auth.user_config'             => 'auth_user_config',
  95   'auth.user_group'              => 'auth_user_group',
  96   ar                             => 'invoice',
  97   ap                             => 'purchase_invoice',
  98   assembly                       => 'assembly',
  99   background_jobs                => 'background_job',
 100   background_job_histories       => 'background_job_history',
 101   ap                             => 'purchase_invoice',
 102   bank_accounts                  => 'bank_account',
 103   buchungsgruppen                => 'buchungsgruppe',
 104   bin                            => 'bin',
 105   business                       => 'business',
 106   chart                          => 'chart',
 107   contacts                       => 'contact',
 108   customer                       => 'customer',
 109   csv_import_profiles            => 'csv_import_profile',
 110   csv_import_profile_settings    => 'csv_import_profile_setting',
 111   csv_import_reports             => 'csv_import_report',
 112   csv_import_report_rows         => 'csv_import_report_row',
 113   csv_import_report_status       => 'csv_import_report_status',
 114   currencies                     => 'currency',
 115   custom_variable_configs        => 'custom_variable_config',
 116   custom_variables               => 'custom_variable',
 117   custom_variables_validity      => 'custom_variable_validity',
 118   datev                          => 'datev',
 119   defaults                       => 'default',
 120   delivery_orders                => 'delivery_order',
 121   delivery_order_items           => 'delivery_order_item',
 122   delivery_order_items_stock     => 'delivery_order_items_stock',
 123   delivery_terms                 => 'delivery_term',
 124   department                     => 'department',
 125   drafts                         => 'draft',
 126   dunning                        => 'dunning',
 127   dunning_config                 => 'dunning_config',
 128   employee                       => 'employee',
 129   exchangerate                   => 'exchangerate',
 130   finanzamt                      => 'finanzamt',
 131   follow_up_access               => 'follow_up_access',
 132   follow_up_links                => 'follow_up_link',
 133   follow_ups                     => 'follow_up',
 134   generic_translations           => 'generic_translation',
 135   gl                             => 'GLTransaction',
 136   history_erp                    => 'history',
 137   inventory                      => 'inventory',
 138   invoice                        => 'invoice_item',
 139   language                       => 'language',
 140   makemodel                      => 'make_model',
 141   notes                          => 'note',
 142   orderitems                     => 'order_item',
 143   oe                             => 'order',
 144   parts                          => 'part',
 145   partsgroup                     => 'parts_group',
 146   payment_terms                  => 'payment_term',
 147   periodic_invoices              => 'periodic_invoice',
 148   periodic_invoices_configs      => 'periodic_invoices_config',
 149   prices                         => 'price',
 150   price_factors                  => 'price_factor',
 151   pricegroup                     => 'pricegroup',
 152   printers                       => 'printer',
 153   project                        => 'project',
 154   project_types                  => 'ProjectType',
 155   record_links                   => 'record_link',
 156   sepa_export                    => 'sepa_export',
 157   sepa_export_items              => 'sepa_export_item',
 158   schema_info                    => 'schema_info',
 159   shipto                         => 'shipto',
 160   status                         => 'status',
 161   tax                            => 'tax',
 162   taxkeys                        => 'tax_key',
 163   tax_zones                      => 'tax_zone',
 164   todo_user_config               => 'todo_user_config',
 165   transfer_type                  => 'transfer_type',
 166   translation                    => 'translation',
 167   units                          => 'unit',
 168   units_language                 => 'units_language',
 169   vendor                         => 'vendor',
 170   warehouse                      => 'warehouse',
 171 );
 172
 173 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
 174
 175 sub get_blacklist {
 176   return KIVITENDO => \@kivitendo_blacklist;
 177 }
 178
 179 sub get_package_names {
 180   return KIVITENDO => \%kivitendo_package_names;
 181 }
 182
 183 sub get_package_for_table {
 184   %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 185     unless %kivitendo_tables_to_packages;
 186
 187   return $kivitendo_tables_to_packages{ $_[0] };
 188 }
 189
 190 sub get_manager_package_for_table {
 191   %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 192     unless %kivitendo_tables_to_manager_packages;
 193
 194   return $kivitendo_tables_to_manager_packages{ $_[0] };
 195 }
 196
 197 sub get_table_for_package {
 198   get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
 199   %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
 200
 201   my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
 202   return $kivitendo_packages_to_tables{ $package };
 203 }
 204
 205 sub db {
 206   my $string = $_[0];
 207   my $lookup = $kivitendo_package_names{$_[0]} ||
 208       plurify($kivitendo_package_names{singlify($_[0])});
 209
 210   for my $thing ($string, $lookup) {
 211
 212     # best guess? its already the name. like part. camelize it first
 213     my $class = "SL::DB::" . camelify($thing);
 214     return $class if defined *{ $class. '::' };
 215
 216     # next, someone wants a manager and pluralized.
 217     my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
 218     return $manager if defined *{ $manager . '::' };
 219   }
 220
 221   die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
 222 }
 223
 224 sub plurify {
 225   my ($str) = @_;
 226   $str . 's';
 227 }
 228
 229 sub singlify {
 230   my ($str) = @_;
 231   local $/ = 's';
 232   chomp $str;
 233   $str;
 234 }
 235
 236 1;
 237
 238 __END__
 239
 240 =encoding utf8
 241
 242 =head1 NAME
 243
 244 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
 245
 246 =head1 SYNOPSIS
 247
 248   use SL::DB::Helper::Mappings qw(@blacklist %table2model);
 249
 250 =head1 DESCRIPTION
 251
 252 This modul stores table <-> model mappings used by the
 253 L<scripts/rose_auto_create_model.pl> script.  If you add a new table that has
 254 custom mappings, add it here.
 255
 256 =head1 FUNCTIONS
 257
 258 =over 4
 259
 260 =item C<db $name>
 261
 262 A special function provided here is C<db>. Without it you'd have to write:
 263
 264   my $part = SL::DB::Part->new(id => 1234);
 265   my @all_parts = SL::DB::Manager::Part->get_all;
 266
 267 with them it becomes:
 268
 269   my $part = db('part')->new(id => 123);
 270   my @all_parts = db('parts')->get_all;
 271
 272 You don't have to care about add that SL::DB:: incantation anymore. Also, a
 273 simple s at the end will get you the associated Manager class.
 274
 275 db is written to try to make sense of what you give it, but if all fails, it
 276 will die with an error.
 277
 278 =item C<get_package_for_table $table_name>
 279
 280 Returns the package name for a table name:
 281
 282   SL::DB::Helper::Mappings::get_package_for_table('oe')
 283   # SL::DB::Order
 284
 285 =item C<get_manager_package_for_table $table_name>
 286
 287 Returns the manager package name for a table name:
 288
 289   SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
 290   # SL::DB::Manager::Order
 291
 292 =item C<get_table_for_package $package_name>
 293
 294 Returns the table name for a package name:
 295
 296   SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
 297   # oe
 298   SL::DB::Helper::Mappings::get_table_for_package('Order')
 299   # oe
 300
 301 =back
 302
 303 =head1 BUGS
 304
 305 nothing yet
 306
 307 =head1 SEE ALSO
 308
 309 L<scripts/rose_auto_create_model.pl>
 310
 311 =head1 AUTHOR
 312
 313 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
 314 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 315
 316 =cut