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   'auth.clients'                 => 'auth_client',
  88   'auth.clients_users'           => 'auth_client_user',
  89   'auth.clients_groups'          => 'auth_client_group',
  90   'auth.group'                   => 'auth_group',
  91   'auth.group_rights'            => 'auth_group_right',
  92   'auth.user'                    => 'auth_user',
  93   'auth.user_config'             => 'auth_user_config',
  94   'auth.user_group'              => 'auth_user_group',
  95   ar                             => 'invoice',
  96   ap                             => 'purchase_invoice',
  97   assembly                       => 'assembly',
  98   background_jobs                => 'background_job',
  99   background_job_histories       => 'background_job_history',
 100   ap                             => 'purchase_invoice',
 101   bank_accounts                  => 'bank_account',
 102   buchungsgruppen                => 'buchungsgruppe',
 103   bin                            => 'bin',
 104   business                       => 'business',
 105   chart                          => 'chart',
 106   contacts                       => 'contact',
 107   customer                       => 'customer',
 108   csv_import_profiles            => 'csv_import_profile',
 109   csv_import_profile_settings    => 'csv_import_profile_setting',
 110   csv_import_reports             => 'csv_import_report',
 111   csv_import_report_rows         => 'csv_import_report_row',
 112   csv_import_report_status       => 'csv_import_report_status',
 113   currencies                     => 'currency',
 114   custom_variable_configs        => 'custom_variable_config',
 115   custom_variables               => 'custom_variable',
 116   custom_variables_validity      => 'custom_variable_validity',
 117   datev                          => 'datev',
 118   defaults                       => 'default',
 119   delivery_orders                => 'delivery_order',
 120   delivery_order_items           => 'delivery_order_item',
 121   delivery_order_items_stock     => 'delivery_order_items_stock',
 122   delivery_terms                 => 'delivery_term',
 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   project_types                  => 'ProjectType',
 154   record_links                   => 'record_link',
 155   requirement_spec_acceptance_statuses => 'RequirementSpecAcceptanceStatus',
 156   requirement_spec_complexities        => 'RequirementSpecComplexity',
 157   requirement_spec_item_dependencies   => 'RequirementSpecDependency',
 158   requirement_spec_items               => 'RequirementSpecItem',
 159   requirement_spec_predefined_texts    => 'RequirementSpecPredefinedText',
 160   requirement_spec_risks               => 'RequirementSpecRisk',
 161   requirement_spec_statuses            => 'RequirementSpecStatus',
 162   requirement_spec_text_blocks         => 'RequirementSpecTextBlock',
 163   requirement_spec_types               => 'RequirementSpecType',
 164   requirement_spec_versions            => 'RequirementSpecVersion',
 165   requirement_specs                    => 'RequirementSpec',
 166   sepa_export                    => 'sepa_export',
 167   sepa_export_items              => 'sepa_export_item',
 168   schema_info                    => 'schema_info',
 169   shipto                         => 'shipto',
 170   status                         => 'status',
 171   tax                            => 'tax',
 172   taxkeys                        => 'tax_key',
 173   tax_zones                      => 'tax_zone',
 174   todo_user_config               => 'todo_user_config',
 175   transfer_type                  => 'transfer_type',
 176   translation                    => 'translation',
 177   units                          => 'unit',
 178   units_language                 => 'units_language',
 179   vendor                         => 'vendor',
 180   warehouse                      => 'warehouse',
 181 );
 182
 183 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
 184
 185 sub get_blacklist {
 186   return KIVITENDO => \@kivitendo_blacklist;
 187 }
 188
 189 sub get_package_names {
 190   return KIVITENDO => \%kivitendo_package_names;
 191 }
 192
 193 sub get_package_for_table {
 194   %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 195     unless %kivitendo_tables_to_packages;
 196
 197   return $kivitendo_tables_to_packages{ $_[0] };
 198 }
 199
 200 sub get_manager_package_for_table {
 201   %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 202     unless %kivitendo_tables_to_manager_packages;
 203
 204   return $kivitendo_tables_to_manager_packages{ $_[0] };
 205 }
 206
 207 sub get_table_for_package {
 208   get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
 209   %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
 210
 211   my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
 212   return $kivitendo_packages_to_tables{ $package };
 213 }
 214
 215 sub db {
 216   my $string = $_[0];
 217   my $lookup = $kivitendo_package_names{$_[0]} ||
 218       plurify($kivitendo_package_names{singlify($_[0])});
 219
 220   for my $thing ($string, $lookup) {
 221
 222     # best guess? its already the name. like part. camelize it first
 223     my $class = "SL::DB::" . camelify($thing);
 224     return $class if defined *{ $class. '::' };
 225
 226     # next, someone wants a manager and pluralized.
 227     my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
 228     return $manager if defined *{ $manager . '::' };
 229   }
 230
 231   die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
 232 }
 233
 234 sub plurify {
 235   my ($str) = @_;
 236   $str . 's';
 237 }
 238
 239 sub singlify {
 240   my ($str) = @_;
 241   local $/ = 's';
 242   chomp $str;
 243   $str;
 244 }
 245
 246 1;
 247
 248 __END__
 249
 250 =encoding utf8
 251
 252 =head1 NAME
 253
 254 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
 255
 256 =head1 SYNOPSIS
 257
 258   use SL::DB::Helper::Mappings qw(@blacklist %table2model);
 259
 260 =head1 DESCRIPTION
 261
 262 This modul stores table <-> model mappings used by the
 263 L<scripts/rose_auto_create_model.pl> script.  If you add a new table that has
 264 custom mappings, add it here.
 265
 266 =head1 FUNCTIONS
 267
 268 =over 4
 269
 270 =item C<db $name>
 271
 272 A special function provided here is C<db>. Without it you'd have to write:
 273
 274   my $part = SL::DB::Part->new(id => 1234);
 275   my @all_parts = SL::DB::Manager::Part->get_all;
 276
 277 with them it becomes:
 278
 279   my $part = db('part')->new(id => 123);
 280   my @all_parts = db('parts')->get_all;
 281
 282 You don't have to care about add that SL::DB:: incantation anymore. Also, a
 283 simple s at the end will get you the associated Manager class.
 284
 285 db is written to try to make sense of what you give it, but if all fails, it
 286 will die with an error.
 287
 288 =item C<get_package_for_table $table_name>
 289
 290 Returns the package name for a table name:
 291
 292   SL::DB::Helper::Mappings::get_package_for_table('oe')
 293   # SL::DB::Order
 294
 295 =item C<get_manager_package_for_table $table_name>
 296
 297 Returns the manager package name for a table name:
 298
 299   SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
 300   # SL::DB::Manager::Order
 301
 302 =item C<get_table_for_package $package_name>
 303
 304 Returns the table name for a package name:
 305
 306   SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
 307   # oe
 308   SL::DB::Helper::Mappings::get_table_for_package('Order')
 309   # oe
 310
 311 =back
 312
 313 =head1 BUGS
 314
 315 nothing yet
 316
 317 =head1 SEE ALSO
 318
 319 L<scripts/rose_auto_create_model.pl>
 320
 321 =head1 AUTHOR
 322
 323 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
 324 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 325
 326 =cut