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_participants           => 'project_participant',
 154   project_phase_participants     => 'project_phase_participant',
 155   project_phases                 => 'project_phase',
 156   project_roles                  => 'project_role',
 157   project_status                 => 'project_status',
 158   project_types                  => 'project_type',
 159   record_links                   => 'record_link',
 160   requirement_spec_acceptance_statuses => 'RequirementSpecAcceptanceStatus',
 161   requirement_spec_complexities        => 'RequirementSpecComplexity',
 162   requirement_spec_item_dependencies   => 'RequirementSpecDependency',
 163   requirement_spec_items               => 'RequirementSpecItem',
 164   requirement_spec_predefined_texts    => 'RequirementSpecPredefinedText',
 165   requirement_spec_risks               => 'RequirementSpecRisk',
 166   requirement_spec_statuses            => 'RequirementSpecStatus',
 167   requirement_spec_text_blocks         => 'RequirementSpecTextBlock',
 168   requirement_spec_types               => 'RequirementSpecType',
 169   requirement_spec_versions            => 'RequirementSpecVersion',
 170   requirement_specs                    => 'RequirementSpec',
 171   sepa_export                    => 'sepa_export',
 172   sepa_export_items              => 'sepa_export_item',
 173   schema_info                    => 'schema_info',
 174   shipto                         => 'shipto',
 175   status                         => 'status',
 176   tax                            => 'tax',
 177   taxkeys                        => 'tax_key',
 178   tax_zones                      => 'tax_zone',
 179   todo_user_config               => 'todo_user_config',
 180   transfer_type                  => 'transfer_type',
 181   translation                    => 'translation',
 182   trigger_information            => 'trigger_information',
 183   units                          => 'unit',
 184   units_language                 => 'units_language',
 185   vendor                         => 'vendor',
 186   warehouse                      => 'warehouse',
 187 );
 188
 189 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
 190
 191 sub get_blacklist {
 192   return KIVITENDO => \@kivitendo_blacklist;
 193 }
 194
 195 sub get_package_names {
 196   return KIVITENDO => \%kivitendo_package_names;
 197 }
 198
 199 sub get_package_for_table {
 200   %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 201     unless %kivitendo_tables_to_packages;
 202
 203   return $kivitendo_tables_to_packages{ $_[0] };
 204 }
 205
 206 sub get_manager_package_for_table {
 207   %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 208     unless %kivitendo_tables_to_manager_packages;
 209
 210   return $kivitendo_tables_to_manager_packages{ $_[0] };
 211 }
 212
 213 sub get_table_for_package {
 214   get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
 215   %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
 216
 217   my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
 218   return $kivitendo_packages_to_tables{ $package };
 219 }
 220
 221 sub db {
 222   my $string = $_[0];
 223   my $lookup = $kivitendo_package_names{$_[0]} ||
 224       plurify($kivitendo_package_names{singlify($_[0])});
 225
 226   for my $thing ($string, $lookup) {
 227
 228     # best guess? its already the name. like part. camelize it first
 229     my $class = "SL::DB::" . camelify($thing);
 230     return $class if defined *{ $class. '::' };
 231
 232     # next, someone wants a manager and pluralized.
 233     my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
 234     return $manager if defined *{ $manager . '::' };
 235   }
 236
 237   die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
 238 }
 239
 240 sub plurify {
 241   my ($str) = @_;
 242   $str . 's';
 243 }
 244
 245 sub singlify {
 246   my ($str) = @_;
 247   local $/ = 's';
 248   chomp $str;
 249   $str;
 250 }
 251
 252 1;
 253
 254 __END__
 255
 256 =encoding utf8
 257
 258 =head1 NAME
 259
 260 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
 261
 262 =head1 SYNOPSIS
 263
 264   use SL::DB::Helper::Mappings qw(@blacklist %table2model);
 265
 266 =head1 DESCRIPTION
 267
 268 This modul stores table <-> model mappings used by the
 269 L<scripts/rose_auto_create_model.pl> script.  If you add a new table that has
 270 custom mappings, add it here.
 271
 272 =head1 FUNCTIONS
 273
 274 =over 4
 275
 276 =item C<db $name>
 277
 278 A special function provided here is C<db>. Without it you'd have to write:
 279
 280   my $part = SL::DB::Part->new(id => 1234);
 281   my @all_parts = SL::DB::Manager::Part->get_all;
 282
 283 with them it becomes:
 284
 285   my $part = db('part')->new(id => 123);
 286   my @all_parts = db('parts')->get_all;
 287
 288 You don't have to care about add that SL::DB:: incantation anymore. Also, a
 289 simple s at the end will get you the associated Manager class.
 290
 291 db is written to try to make sense of what you give it, but if all fails, it
 292 will die with an error.
 293
 294 =item C<get_package_for_table $table_name>
 295
 296 Returns the package name for a table name:
 297
 298   SL::DB::Helper::Mappings::get_package_for_table('oe')
 299   # SL::DB::Order
 300
 301 =item C<get_manager_package_for_table $table_name>
 302
 303 Returns the manager package name for a table name:
 304
 305   SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
 306   # SL::DB::Manager::Order
 307
 308 =item C<get_table_for_package $package_name>
 309
 310 Returns the table name for a package name:
 311
 312   SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
 313   # oe
 314   SL::DB::Helper::Mappings::get_table_for_package('Order')
 315   # oe
 316
 317 =back
 318
 319 =head1 BUGS
 320
 321 nothing yet
 322
 323 =head1 SEE ALSO
 324
 325 L<scripts/rose_auto_create_model.pl>
 326
 327 =head1 AUTHOR
 328
 329 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
 330 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 331
 332 =cut