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