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