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