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   department                     => 'department',
 124   drafts                         => 'draft',
 125   dunning                        => 'dunning',
 126   dunning_config                 => 'dunning_config',
 127   employee                       => 'employee',
 128   exchangerate                   => 'exchangerate',
 129   finanzamt                      => 'finanzamt',
 130   follow_up_access               => 'follow_up_access',
 131   follow_up_links                => 'follow_up_link',
 132   follow_ups                     => 'follow_up',
 133   generic_translations           => 'generic_translation',
 134   gl                             => 'GLTransaction',
 135   history_erp                    => 'history',
 136   inventory                      => 'inventory',
 137   invoice                        => 'invoice_item',
 138   language                       => 'language',
 139   makemodel                      => 'make_model',
 140   notes                          => 'note',
 141   orderitems                     => 'order_item',
 142   oe                             => 'order',
 143   parts                          => 'part',
 144   partsgroup                     => 'parts_group',
 145   payment_terms                  => 'payment_term',
 146   periodic_invoices              => 'periodic_invoice',
 147   periodic_invoices_configs      => 'periodic_invoices_config',
 148   prices                         => 'price',
 149   price_factors                  => 'price_factor',
 150   pricegroup                     => 'pricegroup',
 151   printers                       => 'printer',
 152   project                        => 'project',
 153   record_links                   => 'record_link',
 154   sepa_export                    => 'sepa_export',
 155   sepa_export_items              => 'sepa_export_item',
 156   schema_info                    => 'schema_info',
 157   shipto                         => 'shipto',
 158   status                         => 'status',
 159   tax                            => 'tax',
 160   taxkeys                        => 'tax_key',
 161   tax_zones                      => 'tax_zone',
 162   todo_user_config               => 'todo_user_config',
 163   transfer_type                  => 'transfer_type',
 164   translation                    => 'translation',
 165   units                          => 'unit',
 166   units_language                 => 'units_language',
 167   vendor                         => 'vendor',
 168   warehouse                      => 'warehouse',
 169 );
 170
 171 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
 172
 173 sub get_blacklist {
 174   return KIVITENDO => \@kivitendo_blacklist;
 175 }
 176
 177 sub get_package_names {
 178   return KIVITENDO => \%kivitendo_package_names;
 179 }
 180
 181 sub get_package_for_table {
 182   %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 183     unless %kivitendo_tables_to_packages;
 184
 185   return $kivitendo_tables_to_packages{ $_[0] };
 186 }
 187
 188 sub get_manager_package_for_table {
 189   %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 190     unless %kivitendo_tables_to_manager_packages;
 191
 192   return $kivitendo_tables_to_manager_packages{ $_[0] };
 193 }
 194
 195 sub get_table_for_package {
 196   get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
 197   %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
 198
 199   my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
 200   return $kivitendo_packages_to_tables{ $package };
 201 }
 202
 203 sub db {
 204   my $string = $_[0];
 205   my $lookup = $kivitendo_package_names{$_[0]} ||
 206       plurify($kivitendo_package_names{singlify($_[0])});
 207
 208   for my $thing ($string, $lookup) {
 209
 210     # best guess? its already the name. like part. camelize it first
 211     my $class = "SL::DB::" . camelify($thing);
 212     return $class if defined *{ $class. '::' };
 213
 214     # next, someone wants a manager and pluralized.
 215     my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
 216     return $manager if defined *{ $manager . '::' };
 217   }
 218
 219   die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
 220 }
 221
 222 sub plurify {
 223   my ($str) = @_;
 224   $str . 's';
 225 }
 226
 227 sub singlify {
 228   my ($str) = @_;
 229   local $/ = 's';
 230   chomp $str;
 231   $str;
 232 }
 233
 234 1;
 235
 236 __END__
 237
 238 =encoding utf8
 239
 240 =head1 NAME
 241
 242 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
 243
 244 =head1 SYNOPSIS
 245
 246   use SL::DB::Helper::Mappings qw(@blacklist %table2model);
 247
 248 =head1 DESCRIPTION
 249
 250 This modul stores table <-> model mappings used by the
 251 L<scripts/rose_auto_create_model.pl> script.  If you add a new table that has
 252 custom mappings, add it here.
 253
 254 =head1 FUNCTIONS
 255
 256 =over 4
 257
 258 =item C<db $name>
 259
 260 A special function provided here is C<db>. Without it you'd have to write:
 261
 262   my $part = SL::DB::Part->new(id => 1234);
 263   my @all_parts = SL::DB::Manager::Part->get_all;
 264
 265 with them it becomes:
 266
 267   my $part = db('part')->new(id => 123);
 268   my @all_parts = db('parts')->get_all;
 269
 270 You don't have to care about add that SL::DB:: incantation anymore. Also, a
 271 simple s at the end will get you the associated Manager class.
 272
 273 db is written to try to make sense of what you give it, but if all fails, it
 274 will die with an error.
 275
 276 =item C<get_package_for_table $table_name>
 277
 278 Returns the package name for a table name:
 279
 280   SL::DB::Helper::Mappings::get_package_for_table('oe')
 281   # SL::DB::Order
 282
 283 =item C<get_manager_package_for_table $table_name>
 284
 285 Returns the manager package name for a table name:
 286
 287   SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
 288   # SL::DB::Manager::Order
 289
 290 =item C<get_table_for_package $package_name>
 291
 292 Returns the table name for a package name:
 293
 294   SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
 295   # oe
 296   SL::DB::Helper::Mappings::get_table_for_package('Order')
 297   # oe
 298
 299 =back
 300
 301 =head1 BUGS
 302
 303 nothing yet
 304
 305 =head1 SEE ALSO
 306
 307 L<scripts/rose_auto_create_model.pl>
 308
 309 =head1 AUTHOR
 310
 311 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
 312 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 313
 314 =cut