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