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   additional_billing_addresses   => 'additional_billing_address',
  88   'auth.clients'                 => 'auth_client',
  89   'auth.clients_users'           => 'auth_client_user',
  90   'auth.clients_groups'          => 'auth_client_group',
  91   'auth.group'                   => 'auth_group',
  92   'auth.group_rights'            => 'auth_group_right',
  93   'auth.master_rights'           => 'auth_master_right',
  94   'auth.schema_info'             => 'auth_schema_info',
  95   'auth.session'                 => 'auth_session',
  96   'auth.session_content'         => 'auth_session_content',
  97   'auth.user'                    => 'auth_user',
  98   'auth.user_config'             => 'auth_user_config',
  99   'auth.user_group'              => 'auth_user_group',
 100   ar                             => 'invoice',
 101   ap                             => 'purchase_invoice',
 102   ap_gl                          => 'ap_gl',
 103   assembly                       => 'assembly',
 104   assortment_items               => 'assortment_item',
 105   background_jobs                => 'background_job',
 106   background_job_histories       => 'background_job_history',
 107   bank_accounts                  => 'bank_account',
 108   bank_transactions              => 'bank_transaction',
 109   bank_transaction_acc_trans     => 'bank_transaction_acc_trans',
 110   buchungsgruppen                => 'buchungsgruppe',
 111   bin                            => 'bin',
 112   business                       => 'business',
 113   business_models                => 'business_model',
 114   chart                          => 'chart',
 115   contact_departments            => 'contact_department',
 116   contact_titles                 => 'contact_title',
 117   contacts                       => 'contact',
 118   customer                       => 'customer',
 119   csv_import_profiles            => 'csv_import_profile',
 120   csv_import_profile_settings    => 'csv_import_profile_setting',
 121   csv_import_reports             => 'csv_import_report',
 122   csv_import_report_rows         => 'csv_import_report_row',
 123   csv_import_report_status       => 'csv_import_report_status',
 124   currencies                     => 'currency',
 125   custom_data_export_queries     => 'CustomDataExportQuery',
 126   custom_data_export_query_parameters => 'CustomDataExportQueryParameter',
 127   custom_variable_config_partsgroups => 'custom_variable_config_partsgroup',
 128   custom_variable_configs        => 'custom_variable_config',
 129   custom_variables               => 'custom_variable',
 130   custom_variables_validity      => 'custom_variable_validity',
 131   datev                          => 'datev',
 132   defaults                       => 'default',
 133   delivery_orders                => 'delivery_order',
 134   delivery_order_items           => 'delivery_order_item',
 135   delivery_order_items_stock     => 'delivery_order_items_stock',
 136   delivery_terms                 => 'delivery_term',
 137   department                     => 'department',
 138   drafts                         => 'draft',
 139   dunning                        => 'dunning',
 140   dunning_config                 => 'dunning_config',
 141   email_imports                  => 'EmailImport',
 142   email_journal                  => 'EmailJournal',
 143   email_journal_attachments      => 'EmailJournalAttachment',
 144   employee                       => 'employee',
 145   employee_project_invoices      => 'EmployeeProjectInvoices',
 146   exchangerate                   => 'exchangerate',
 147   files                          => 'file',
 148   file_versions                  => 'file_version',
 149   file_full_texts                => 'file_full_text',
 150   finanzamt                      => 'finanzamt',
 151   follow_up_access               => 'follow_up_access',
 152   follow_up_created_for_employees => 'follow_up_created_for_employee',
 153   follow_up_done                 => 'follow_up_done',
 154   follow_up_links                => 'follow_up_link',
 155   follow_ups                     => 'follow_up',
 156   generic_translations           => 'generic_translation',
 157   gl                             => 'GLTransaction',
 158   greetings                      => 'greeting',
 159   history_erp                    => 'history',
 160   inventory                      => 'inventory',
 161   invoice                        => 'invoice_item',
 162   language                       => 'language',
 163   letter                         => 'letter',
 164   letter_draft                   => 'letter_draft',
 165   makemodel                      => 'make_model',
 166   mebil_mapping                  => 'mebil_mapping',
 167   notes                          => 'note',
 168   order_statuses                 => 'order_status',
 169   orderitems                     => 'order_item',
 170   oe                             => 'order',
 171   oe_version                     => 'order_version',
 172   parts                          => 'part',
 173   partsgroup                     => 'parts_group',
 174   part_classifications           => 'PartClassification',
 175   part_customer_prices           => 'PartCustomerPrice',
 176   parts_price_history            => 'PartsPriceHistory',
 177   payment_terms                  => 'payment_term',
 178   periodic_invoices              => 'periodic_invoice',
 179   periodic_invoices_configs      => 'periodic_invoices_config',
 180   prices                         => 'price',
 181   price_factors                  => 'price_factor',
 182   price_rules                    => 'price_rule',
 183   price_rule_items               => 'price_rule_item',
 184   pricegroup                     => 'pricegroup',
 185   printers                       => 'printer',
 186   project                        => 'project',
 187   project_participants           => 'project_participant',
 188   project_phase_participants     => 'project_phase_participant',
 189   project_phases                 => 'project_phase',
 190   project_roles                  => 'project_role',
 191   project_statuses               => 'project_status',
 192   project_types                  => 'project_type',
 193   purchase_basket_items          => 'purchase_basket_item',
 194   reclamations                   => 'Reclamation',
 195   reclamation_items              => 'ReclamationItem',
 196   reclamation_reasons            => 'ReclamationReason',
 197   reconciliation_links           => 'reconciliation_link',
 198   record_links                   => 'record_link',
 199   record_templates               => 'record_template',
 200   record_template_items          => 'record_template_item',
 201   requirement_spec_acceptance_statuses => 'RequirementSpecAcceptanceStatus',
 202   requirement_spec_complexities        => 'RequirementSpecComplexity',
 203   requirement_spec_item_dependencies   => 'RequirementSpecDependency',
 204   requirement_spec_items               => 'RequirementSpecItem',
 205   requirement_spec_orders              => 'RequirementSpecOrder',
 206   requirement_spec_parts               => 'RequirementSpecPart',
 207   requirement_spec_pictures            => 'RequirementSpecPicture',
 208   requirement_spec_predefined_texts    => 'RequirementSpecPredefinedText',
 209   requirement_spec_risks               => 'RequirementSpecRisk',
 210   requirement_spec_statuses            => 'RequirementSpecStatus',
 211   requirement_spec_text_blocks         => 'RequirementSpecTextBlock',
 212   requirement_spec_types               => 'RequirementSpecType',
 213   requirement_spec_versions            => 'RequirementSpecVersion',
 214   requirement_specs                    => 'RequirementSpec',
 215   sepa_export                    => 'sepa_export',
 216   sepa_export_items              => 'sepa_export_item',
 217   sepa_export_message_ids        => 'SepaExportMessageId',
 218   schema_info                    => 'schema_info',
 219   shipto                         => 'shipto',
 220   shops                          => 'shop',
 221   shop_images                    => 'shop_image',
 222   shop_orders                    => 'shop_order',
 223   shop_order_items               => 'shop_order_item',
 224   shop_parts                     => 'shop_part',
 225   status                         => 'status',
 226   stocktakings                   => 'stocktaking',
 227   tax                            => 'tax',
 228   taxkeys                        => 'tax_key',
 229   tax_zones                      => 'tax_zone',
 230   taxzone_charts                 => 'taxzone_chart',
 231   time_recording_articles        => 'time_recording_article',
 232   time_recordings                => 'time_recording',
 233   todo_user_config               => 'todo_user_config',
 234   transfer_type                  => 'transfer_type',
 235   translation                    => 'translation',
 236   trigger_information            => 'trigger_information',
 237   units                          => 'unit',
 238   units_language                 => 'units_language',
 239   user_preferences               => 'user_preference',
 240   validity_tokens                => 'ValidityToken',
 241   vendor                         => 'vendor',
 242   warehouse                      => 'warehouse',
 243 );
 244
 245 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
 246
 247 sub get_blacklist {
 248   return KIVITENDO => \@kivitendo_blacklist;
 249 }
 250
 251 sub get_package_names {
 252   return KIVITENDO => \%kivitendo_package_names;
 253 }
 254
 255 sub get_name_for_table {
 256   return $kivitendo_package_names{ $_[0] };
 257 }
 258
 259 sub get_package_for_table {
 260   %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 261     unless %kivitendo_tables_to_packages;
 262
 263   return $kivitendo_tables_to_packages{ $_[0] };
 264 }
 265
 266 sub get_manager_package_for_table {
 267   %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
 268     unless %kivitendo_tables_to_manager_packages;
 269
 270   return $kivitendo_tables_to_manager_packages{ $_[0] };
 271 }
 272
 273 sub get_table_for_package {
 274   get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
 275   %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
 276
 277   my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
 278   return $kivitendo_packages_to_tables{ $package };
 279 }
 280
 281 sub db {
 282   my $string = $_[0];
 283   my $lookup = $kivitendo_package_names{$_[0]} ||
 284       plurify($kivitendo_package_names{singlify($_[0])});
 285
 286   for my $thing ($string, $lookup) {
 287
 288     # best guess? its already the name. like part. camelize it first
 289     my $class = "SL::DB::" . camelify($thing);
 290     return $class if defined *{ $class. '::' };
 291
 292     # next, someone wants a manager and pluralized.
 293     my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
 294     return $manager if defined *{ $manager . '::' };
 295   }
 296
 297   die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
 298 }
 299
 300 sub plurify {
 301   my ($str) = @_;
 302   $str . 's';
 303 }
 304
 305 sub singlify {
 306   my ($str) = @_;
 307   local $/ = 's';
 308   chomp $str;
 309   $str;
 310 }
 311
 312 1;
 313
 314 __END__
 315
 316 =encoding utf8
 317
 318 =head1 NAME
 319
 320 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
 321
 322 =head1 SYNOPSIS
 323
 324   use SL::DB::Helper::Mappings qw(@blacklist %table2model);
 325
 326 =head1 DESCRIPTION
 327
 328 This modul stores table <-> model mappings used by the
 329 L<scripts/rose_auto_create_model.pl> script.  If you add a new table that has
 330 custom mappings, add it here.
 331
 332 =head1 FUNCTIONS
 333
 334 =over 4
 335
 336 =item C<db $name>
 337
 338 A special function provided here is C<db>. Without it you'd have to write:
 339
 340   my $part = SL::DB::Part->new(id => 1234);
 341   my @all_parts = SL::DB::Manager::Part->get_all;
 342
 343 with them it becomes:
 344
 345   my $part = db('part')->new(id => 123);
 346   my @all_parts = db('parts')->get_all;
 347
 348 You don't have to care about add that SL::DB:: incantation anymore. Also, a
 349 simple s at the end will get you the associated Manager class.
 350
 351 db is written to try to make sense of what you give it, but if all fails, it
 352 will die with an error.
 353
 354 =item C<get_package_for_table $table_name>
 355
 356 Returns the package name for a table name:
 357
 358   SL::DB::Helper::Mappings::get_package_for_table('oe')
 359   # SL::DB::Order
 360
 361 =item C<get_manager_package_for_table $table_name>
 362
 363 Returns the manager package name for a table name:
 364
 365   SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
 366   # SL::DB::Manager::Order
 367
 368 =item C<get_table_for_package $package_name>
 369
 370 Returns the table name for a package name:
 371
 372   SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
 373   # oe
 374   SL::DB::Helper::Mappings::get_table_for_package('Order')
 375   # oe
 376
 377 =back
 378
 379 =head1 BUGS
 380
 381 nothing yet
 382
 383 =head1 SEE ALSO
 384
 385 L<scripts/rose_auto_create_model.pl>
 386
 387 =head1 AUTHOR
 388
 389 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
 390 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 391
 392 =cut