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