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