X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Frose_auto_create_model.pl;h=8106576a84b3e69342d69f24acd58a3c5d9b189e;hb=cb0ae4e41048ffba9a7e3c6f52c21ea11728f42d;hp=7aab08393be2cc44801b9a8a11e3254a911dd2ab;hpb=21daf701fac24bbc753abae8d8f5f6b8bcf984f7;p=kivitendo-erp.git diff --git a/scripts/rose_auto_create_model.pl b/scripts/rose_auto_create_model.pl index 7aab08393..8106576a8 100755 --- a/scripts/rose_auto_create_model.pl +++ b/scripts/rose_auto_create_model.pl @@ -13,8 +13,10 @@ use Data::Dumper; use Digest::MD5 qw(md5_hex); use English qw( -no_match_vars ); use Getopt::Long; -use List::MoreUtils qw(any); +use List::MoreUtils qw(none); +use List::UtilsBy qw(partition_by); use Pod::Usage; +use Rose::DB::Object 0.809; use Term::ANSIColor; use SL::Auth; @@ -40,86 +42,161 @@ $script =~ s:.*/::; $OUTPUT_AUTOFLUSH = 1; $Data::Dumper::Sortkeys = 1; -our $meta_path = "SL/DB/MetaSetup"; +our $meta_path = "SL/DB/MetaSetup"; +our $manager_path = "SL/DB/Manager"; my %config; -our %foreign_key_name_map = ( - oe => { payment => 'payment_terms', }, - ar => { payment => 'payment_terms', }, - ap => { payment => 'payment_terms', }, - - orderitems => { parts => 'part', trans => 'order', }, - delivery_order_items => { parts => 'part' }, - invoice => { parts => 'part' }, - - periodic_invoices_configs => { oe => 'order' }, +# Maps column names in tables to foreign key relationship names. For +# example: +# +# »follow_up_access« contains a column named »who«. Rose normally +# names the resulting relationship after the class the target table +# uses. In this case the target table is »employee« and the +# corresponding class SL::DB::Employee. The resulting relationship +# would be named »employee«. +# +# In order to rename this relationship we have to map »who« to +# e.g. »granted_by«: +# follow_up_access => { who => 'granted_by' }, + +our %foreign_key_name_map = ( + KIVITENDO => { + oe => { payment_id => 'payment_terms', }, + ar => { payment_id => 'payment_terms', }, + ap => { payment_id => 'payment_terms', }, + + orderitems => { parts_id => 'part', trans_id => 'order', }, + delivery_order_items => { parts_id => 'part' }, + invoice => { parts_id => 'part' }, + follow_ups => { created_for_user => 'created_for', created_by => 'created_by', }, + follow_up_access => { who => 'with_access', what => 'to_follow_ups_by', }, + + periodic_invoices_configs => { oe_id => 'order' }, + }, ); sub setup { SL::LxOfficeConf->read; - my $login = $config{login} || $::lx_office_conf{devel}{login}; + my $client = $config{client} || $::lx_office_conf{devel}{client}; - if (!$login) { - error("No login found in config. Please provide a login:"); + if (!$client) { + error("No client found in config. Please provide a client:"); usage(); } $::lxdebug = LXDebug->new(); $::locale = Locale->new("de"); $::form = new Form; - $::auth = SL::Auth->new(); - $::user = User->new(login => $login); - %::myconfig = $auth->read_user(login => $login); - $::request = { cgi => CGI->new({}) }; $form->{script} = 'rose_meta_data.pl'; - $form->{login} = $login; + $::auth = SL::Auth->new(); + + if (!$::auth->set_client($client)) { + error("No client with ID or name '$client' found in config. Please provide a client:"); + usage(); + } + + foreach (($meta_path, $manager_path)) { + mkdir $_ unless -d; + } +} + +sub fix_relationship_names { + my ($domain, $table, $fkey_text) = @_; + + if ($fkey_text !~ m/key_columns \s+ => \s+ \{ \s+ ['"]? ( [^'"\s]+ ) /x) { + die "fix_relationship_names: could not extract the key column for domain/table $domain/$table; foreign key definition text:\n${fkey_text}\n"; + } + + my $column_name = $1; + my %changes = map { %{$_} } grep { $_ } ($foreign_key_name_map{$domain}->{ALL}, $foreign_key_name_map{$domain}->{$table}); - map { $form->{$_} = $::myconfig{$_} } qw(stylesheet charset); + if (my $desired_name = $changes{$column_name}) { + $fkey_text =~ s/^ \s\s [^\s]+ \b/ ${desired_name}/msx; + } - mkdir $meta_path unless -d $meta_path; + return $fkey_text; } sub process_table { - my @spec = split(/=/, shift, 2); - my $table = $spec[0]; + my ($domain, $table, $package) = @_; my $schema = ''; ($schema, $table) = split(m/\./, $table) if $table =~ m/\./; - my $package = ucfirst($spec[1] || $spec[0]); + $package = ucfirst($package || $table); $package =~ s/_+(.)/uc($1)/ge; my $meta_file = "${meta_path}/${package}.pm"; + my $mngr_file = "${manager_path}/${package}.pm"; my $file = "SL/DB/${package}.pm"; - $schema = <meta->schema('$schema'); + my $schema_str = $schema ? <meta->schema('$schema'); CODE - my $definition = eval <meta->table('$table'); -$schema + $schema_str __PACKAGE__->meta->auto_initialize; - __PACKAGE__->meta->perl_class_definition(indent => 2); # , braces => 'bsd' CODE if ($EVAL_ERROR) { error("Error in execution for table '$table'"); - error("'$EVAL_ERROR'") if $config{verbose}; + error("'$EVAL_ERROR'") unless $config{quiet}; return; } + my %args = (indent => 2, use_setup => 0); + + my $definition = "SL::DB::AUTO::$package"->meta->perl_class_definition(%args); + $definition =~ s/\n+__PACKAGE__->meta->initialize;\n+/\n\n/; $definition =~ s/::AUTO::/::/g; - while (my ($auto_generated_name, $desired_name) = each %{ $foreign_key_name_map{$table} || {} }) { - $definition =~ s/( foreign_keys \s*=> \s*\[ .* ^\s+ ) ${auto_generated_name} \b/${1}${desired_name}/msx; + + # Sort column definitions alphabetically + if ($definition =~ m/__PACKAGE__->meta->columns\( \n (.+?) \n \);/msx) { + my ($start, $end) = ($-[1], $+[1]); + my $sorted_columns = join "\n", sort split m/\n/, $1; + substr $definition, $start, $end - $start, $sorted_columns; } + # patch foreign keys + my $foreign_key_definition = "SL::DB::AUTO::$package"->meta->perl_foreign_keys_definition(%args); + $foreign_key_definition =~ s/::AUTO::/::/g; + + if ($foreign_key_definition && ($definition =~ /\Q$foreign_key_definition\E/)) { + # These positions refer to the whole setup call, not just the + # parameters/actual relationship definitions. + my ($start, $end) = ($-[0], $+[0]); + + # Match the function parameters = the actual relationship + # definitions + next unless $foreign_key_definition =~ m/\(\n(.+)\n\)/s; + + my ($list_start, $list_end) = ($-[0], $+[0]); + + # Split the whole chunk on double new lines. The resulting + # elements are one relationship each. Then fix the relationship + # names and sort them by their new names. + my @new_foreign_keys = sort map { fix_relationship_names($domain, $table, $_) } split m/\n\n/m, $1; + + # Replace the function parameters = the actual relationship + # definitions with the new ones. + my $sorted_foreign_keys = "(\n" . join("\n\n", @new_foreign_keys) . "\n)"; + substr $foreign_key_definition, $list_start, $list_end - $list_start, $sorted_foreign_keys; + + # Replace the whole setup call in the auto-generated output with + # our new version. + substr $definition, $start, $end - $start, $foreign_key_definition; + } + + $definition =~ s/(meta->table.*)\n/$1\n$schema_str/m if $schema; + my $full_definition = <meta->make_manager_class; +__PACKAGE__->meta->initialize; 1; CODE @@ -149,8 +226,8 @@ CODE my $old_md5 = md5_hex($orig_file); my $new_size = length $full_definition; my $new_md5 = md5_hex($full_definition); - if ($old_size == $new_size && $old_md5 == $new_md5) { - notice("No changes in $meta_file, skipping.") if $config{verbose}; + if ($old_size == $new_size && $old_md5 eq $new_md5) { + notice("No changes in $meta_file, skipping.") unless $config{quiet}; return; } @@ -164,31 +241,59 @@ CODE notice("File '$meta_file' " . ($file_exists ? 'updated' : 'created') . " for table '$table'"); - if (! -f $file) { - if (!$config{nocommit}) { - open my $out, ">", $file || die; - print $out $meta_definition; - } + return if -f $file; - notice("File '$file' created as well."); + if (!$config{nocommit}) { + open my $out, ">", $file || die; + print $out $meta_definition; } + + notice("File '$file' created as well."); + + return if -f $mngr_file; + + if (!$config{nocommit}) { + open my $out, ">", $mngr_file || die; + print $out <make_manager_methods; + +1; +EOT + } + + notice("File '$mngr_file' created as well."); } sub parse_args { my ($options) = @_; GetOptions( - 'login|user=s' => \ my $login, + 'client=s' => \ my $client, all => \ my $all, + 'db=s' => \ my $db, 'no-commit|dry-run' => \ my $nocommit, help => sub { pod2usage(verbose => 99, sections => 'NAME|SYNOPSIS|OPTIONS') }, - verbose => \ my $verbose, + quiet => \ my $quiet, diff => \ my $diff, ); - $options->{login} = $login if $login; + $options->{client} = $client; $options->{all} = $all; + $options->{db} = $db; $options->{nocommit} = $nocommit; - $options->{verbose} = $verbose; + $options->{quiet} = $quiet; + $options->{color} = -t STDOUT ? 1 : 0; if ($diff) { if (eval { require Text::Diff; 1 }) { @@ -209,7 +314,11 @@ sub show_diff { Text::Diff::diff($text_a, $text_b, { OUTPUT => sub { for (split /\n/, $_[0]) { - print colored($_, $colors{substr($_, 0, 1)}), $/; + if ($config{color}) { + print colored($_, $colors{substr($_, 0, 1)}), $/; + } else { + print $_, $/; + } } }}); } @@ -219,21 +328,32 @@ sub usage { } sub make_tables { - my @tables; + my %tables_by_domain; if ($config{all}) { - my $db = SL::DB::create(undef, 'LXOFFICE'); - @tables = - map { $package_names{LXOFFICE}->{$_} ? "$_=" . $package_names{LXOFFICE}->{$_} : $_ } - grep { my $table = $_; !any { $_ eq $table } @{ $blacklist{LXOFFICE} } } - $db->list_tables; + my @domains = $config{db} ? (uc $config{db}) : sort keys %package_names; + + foreach my $domain (@domains) { + my $db = SL::DB::create(undef, $domain); + $tables_by_domain{$domain} = [ grep { my $table = $_; none { $_ eq $table } @{ $blacklist{$domain} } } $db->list_tables ]; + $db->disconnect; + } + } elsif (@ARGV) { - @tables = @ARGV; + %tables_by_domain = partition_by { + my ($domain, $table) = split m{:}; + $table ? uc($domain) : 'KIVITENDO'; + } @ARGV; + + foreach my $tables (values %tables_by_domain) { + s{.*:}{} for @{ $tables }; + } + } else { error("You specified neither --all nor any specific tables."); usage(); } - @tables; + return %tables_by_domain; } sub error { @@ -244,15 +364,31 @@ sub notice { print @_, $/; } +sub check_errors_in_package_names { + foreach my $domain (sort keys %package_names) { + my @both = grep { $package_names{$domain}->{$_} } @{ $blacklist{$domain} || [] }; + next unless @both; + + print "Error: domain '$domain': The following table names are present in both the black list and the package name hash: ", join(' ', sort @both), "\n"; + exit 1; + } +} + parse_args(\%config); setup(); -my @tables = make_tables(); +check_errors_in_package_names(); -for my $table (@tables) { - # add default model name unless model name is given or no defaults exists - $table .= '=' . $package_names{LXOFFICE}->{lc $table} if $table !~ /=/ && $package_names{LXOFFICE}->{lc $table}; +my %tables_by_domain = make_tables(); - process_table($table); +foreach my $domain (keys %tables_by_domain) { + my @tables = @{ $tables_by_domain{$domain} }; + my @unknown_tables = grep { !$package_names{$domain}->{$_} } @tables; + if (@unknown_tables) { + error("The following tables do not have entries in \%SL::DB::Helper::Mappings::${domain}_package_names: " . join(' ', sort @unknown_tables)); + exit 1; + } + + process_table($domain, $_, $package_names{$domain}->{$_}) for @tables; } 1; @@ -267,20 +403,20 @@ rose_auto_create_model - mana Rose::DB::Object classes for kivitendo =head1 SYNOPSIS - scripts/rose_create_model.pl --login login table1[=package1] [table2[=package2] ...] - scripts/rose_create_model.pl --login login [--all|-a] + scripts/rose_auto_create_model.pl --client name-or-id [db1:]table1 [[db2:]table2 ...] + scripts/rose_auto_create_model.pl --client name-or-id [--all|-a] # updates all models - scripts/rose_create_model.pl --login login --all + scripts/rose_auto_create_model.pl --client name-or-id --all [--db db] # updates only customer table, login taken from config - scripts/rose_create_model.pl customer + scripts/rose_auto_create_model.pl customer # updates only parts table, package will be Part - scripts/rose_create_model.pl parts=Part + scripts/rose_auto_create_model.pl parts=Part # try to update parts, but don't do it. tell what would happen in detail - scripts/rose_create_model.pl --no-commit --verbose parts + scripts/rose_auto_create_model.pl --no-commit parts =head1 DESCRIPTION @@ -317,27 +453,45 @@ In the most basic version, just give it a login and a table name, and it will load the schema information for this table and create the appropriate class files, or update them if already present. -Each table has two associated files. A C class, which is -a perl version of the schema definition, and a C class file. The -first one will be updated if the schema changes, the second one will only be -created if it does not exist. +Each table has three associated files. A C +class, which is a perl version of the schema definition, a +C class file and a C manager class +file. The first one will be updated if the schema changes, the second +and third ones will only be created if it they do not exist. + +=head1 DATABASE NAMES AND TABLES + +If you want to generate the data for specific tables only then you +have to list them on the command line. The format is +C. The part C is optional and defaults +to C – which means the tables in the default kivitendo +database. + +Valid database names are keys in the hash returned by +L. =head1 OPTIONS =over 4 -=item C<--login, -l LOGIN> +=item C<--client, -c CLIENT> -=item C<--user, -u LOGIN> +Provide a client whose database settings are used. If not present the +client is loaded from the config key C. If that too is +not found, an error is thrown. -Provide a login. If not present the login is loaded from the config key -C. If that too is not found, an error is thrown. +Note that C can be either a database ID or a client's name. =item C<--all, -a> Process all tables from the database. Only those that are blacklistes in L are excluded. +=item C<--db db> + +In combination with C<--all> causes all tables in the specific +database to be processed, not in all databases. + =item C<--no-commit, -n> =item C<--dry-run> @@ -354,10 +508,10 @@ different. Beware, does not imply C<--no-commit>. Print this help. -=item C<--verbose, -v> +=item C<--quiet, -q> -Prints extra information, such as skipped files that were not changed and -errors where the auto initialization failed. +Does not print extra information, such as skipped files that were not +changed and errors where the auto initialization failed. =back @@ -367,6 +521,7 @@ None yet. =head1 AUTHOR +Moritz Bunkus Em.bunkus@linet-services.deE, Sven Schöling Es.schoeling@linet-services.deE =cut