}
use CGI qw( -no_xhtml);
+use Config::Std;
use Data::Dumper;
+use Digest::MD5 qw(md5_hex);
use English qw( -no_match_vars );
-use List::MoreUtils qw(any);
+use Getopt::Long;
+use List::MoreUtils qw(none);
+use Pod::Usage;
+use Term::ANSIColor;
use SL::Auth;
use SL::DBUtils;
use SL::Form;
use SL::Locale;
use SL::LXDebug;
+use SL::LxOfficeConf;
use SL::DB::Helper::ALL;
use SL::DB::Helper::Mappings;
+my %blacklist = SL::DB::Helper::Mappings->get_blacklist;
+my %package_names = SL::DB::Helper::Mappings->get_package_names;
+
our $form;
-our $cgi;
our $auth;
+our %lx_office_conf;
our $script = __FILE__;
$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' },
+ follow_ups => { 'employee_obj' => 'created_for' },
+
+ periodic_invoices_configs => { oe => 'order' },
+);
sub setup {
- if (@ARGV < 2) {
- print "Usage: $PROGRAM_NAME login table1[=package1] [table2[=package2] ...]\n";
- print " or $PROGRAM_NAME login [--all|-a] [--sugar|-s]\n";
- exit 1;
- }
- my $login = shift @ARGV;
+ SL::LxOfficeConf->read;
- $::lxdebug = LXDebug->new();
+ my $client = $config{client} || $::lx_office_conf{devel}{client};
- require "config/lx-erp.conf";
- require "config/lx-erp-local.conf" if -f "config/lx-erp-local.conf";
+ if (!$client) {
+ error("No client found in config. Please provide a client:");
+ usage();
+ }
- # locale messages
+ $::lxdebug = LXDebug->new();
$::locale = Locale->new("de");
$::form = new Form;
- $::cgi = new CGI('');
- $::auth = SL::Auth->new();
-
- $::user = User->new($login);
-
- %::myconfig = $auth->read_user($login);
$form->{script} = 'rose_meta_data.pl';
- $form->{login} = $login;
+ $::auth = SL::Auth->new();
- map { $form->{$_} = $::myconfig{$_} } qw(stylesheet charset);
+ if (!$::auth->set_client($client)) {
+ error("No client with ID or name '$client' found in config. Please provide a client:");
+ usage();
+ }
- mkdir $meta_path unless -d $meta_path;
+ foreach (($meta_path, $manager_path)) {
+ mkdir $_ unless -d;
+ }
}
sub process_table {
- my @spec = split(/=/, shift, 2);
+ my @spec = @_;
my $table = $spec[0];
my $schema = '';
($schema, $table) = split(m/\./, $table) if $table =~ m/\./;
my $package = ucfirst($spec[1] || $spec[0]);
$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 = <<CODE if $schema;
- __PACKAGE__->meta->schema('$schema');
+ my $schema_str = $schema ? <<CODE : '';
+__PACKAGE__->meta->schema('$schema');
CODE
- my $definition = eval <<CODE;
+ eval <<CODE;
package SL::DB::AUTO::$package;
use SL::DB::Object;
use base qw(SL::DB::Object);
__PACKAGE__->meta->table('$table');
-$schema
+ $schema_str
__PACKAGE__->meta->auto_initialize;
- __PACKAGE__->meta->perl_class_definition(indent => 2); # , braces => 'bsd'
CODE
if ($EVAL_ERROR) {
- print STDERR "Error in execution for table '$table': $EVAL_ERROR";
+ error("Error in execution for table '$table'");
+ 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;
- my $file_exists = -f $meta_file;
- open(OUT, ">$meta_file") || die;
- print OUT <<CODE;
+ # 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/)) {
+ my ($start, $end) = ($-[0], $+[0]);
+
+ while (my ($auto_generated_name, $desired_name) = each %{ $foreign_key_name_map{$table} || {} }) {
+ $foreign_key_definition =~ s/^ \s \s ${auto_generated_name} \b/ ${desired_name}/msx;
+ }
+
+ # Sort foreign key definitions alphabetically
+ if ($foreign_key_definition =~ m/\(\n(.+)\n\)/s) {
+ my ($list_start, $list_end) = ($-[0], $+[0]);
+ my @foreign_keys = split m/\n\n/m, $1;
+ my $sorted_foreign_keys = "(\n" . join("\n\n", sort @foreign_keys) . "\n)";
+
+ substr $foreign_key_definition, $list_start, $list_end - $list_start, $sorted_foreign_keys;;
+ }
+
+ substr($definition, $start, $end - $start) = $foreign_key_definition;
+ }
+
+ $definition =~ s/(meta->table.*)\n/$1\n$schema_str/m if $schema;
+
+ my $full_definition = <<CODE;
# This file has been auto-generated. Do not modify it; it will be overwritten
# by $::script automatically.
$definition;
CODE
- close OUT;
- print "File '$meta_file' " . ($file_exists ? 'updated' : 'created') . " for table '$table'\n";
-
- if (! -f $file) {
- open(OUT, ">$file") || die;
- print OUT <<CODE;
+ my $meta_definition = <<CODE;
# This file has been auto-generated only because it didn't exist.
# Feel free to modify it at will; it will not be overwritten automatically.
use strict;
use SL::DB::MetaSetup::${package};
+use SL::DB::Manager::${package};
-# Creates get_all, get_all_count, get_all_iterator, delete_all and update_all.
-__PACKAGE__->meta->make_manager_class;
+__PACKAGE__->meta->initialize;
1;
CODE
- close OUT;
- print "File '$file' created as well.\n";
+ my $file_exists = -f $meta_file;
+ if ($file_exists) {
+ my $old_size = -s $meta_file;
+ my $orig_file = do { local(@ARGV, $/) = ($meta_file); <> };
+ 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.") unless $config{quiet};
+ return;
+ }
+
+ show_diff(\$orig_file, \$full_definition) if $config{show_diff};
+ }
+
+ if (!$config{nocommit}) {
+ open my $out, ">", $meta_file || die;
+ print $out $full_definition;
+ }
+
+ notice("File '$meta_file' " . ($file_exists ? 'updated' : 'created') . " for table '$table'");
+
+ return if -f $file;
+
+ 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 <<EOT;
+# This file has been auto-generated only because it didn't exist.
+# Feel free to modify it at will; it will not be overwritten automatically.
+
+package SL::DB::Manager::${package};
+
+use strict;
+
+use SL::DB::Helper::Manager;
+use base qw(SL::DB::Helper::Manager);
+
+sub object_class { 'SL::DB::${package}' }
+
+__PACKAGE__->make_manager_methods;
+
+1;
+EOT
+ }
+
+ notice("File '$mngr_file' created as well.");
}
-setup();
+sub parse_args {
+ my ($options) = @_;
+ GetOptions(
+ 'client=s' => \ my $client,
+ all => \ my $all,
+ 'no-commit|dry-run' => \ my $nocommit,
+ help => sub { pod2usage(verbose => 99, sections => 'NAME|SYNOPSIS|OPTIONS') },
+ quiet => \ my $quiet,
+ diff => \ my $diff,
+ );
+
+ $options->{client} = $client;
+ $options->{all} = $all;
+ $options->{nocommit} = $nocommit;
+ $options->{quiet} = $quiet;
+ $options->{color} = -t STDOUT ? 1 : 0;
+
+ if ($diff) {
+ if (eval { require Text::Diff; 1 }) {
+ $options->{show_diff} = 1;
+ } else {
+ error('Could not load Text::Diff. Sorry, no diffs for you.');
+ }
+ }
+}
-my %blacklist = SL::DB::Helper::Mappings->get_blacklist;
-my %package_names = SL::DB::Helper::Mappings->get_package_names;
+sub show_diff {
+ my ($text_a, $text_b) = @_;
+
+ my %colors = (
+ '+' => 'green',
+ '-' => 'red',
+ );
+
+ Text::Diff::diff($text_a, $text_b, { OUTPUT => sub {
+ for (split /\n/, $_[0]) {
+ if ($config{color}) {
+ print colored($_, $colors{substr($_, 0, 1)}), $/;
+ } else {
+ print $_, $/;
+ }
+ }
+ }});
+}
+
+sub usage {
+ pod2usage(verbose => 99, sections => 'SYNOPSIS');
+}
+
+sub make_tables {
+ my @tables;
+ if ($config{all}) {
+ my $db = SL::DB::create(undef, 'KIVITENDO');
+ @tables = grep { my $table = $_; none { $_ eq $table } @{ $blacklist{KIVITENDO} } } $db->list_tables;
+
+ } elsif (@ARGV) {
+ @tables = @ARGV;
+ } else {
+ error("You specified neither --all nor any specific tables.");
+ usage();
+ }
+
+ @tables;
+}
-my @tables = ();
-if (($ARGV[0] eq '--all') || ($ARGV[0] eq '-a') || ($ARGV[0] eq '--sugar') || ($ARGV[0] eq '-s')) {
- my ($type, $prefix) = ($ARGV[0] eq '--sugar') || ($ARGV[0] eq '-s') ? ('SUGAR', 'sugar_') : ('LXOFFICE', '');
- my $db = SL::DB::create(undef, $type);
- @tables = map { $package_names{$type}->{$_} ? "${_}=" . $package_names{$type}->{$_} : $prefix ? "${_}=${prefix}${_}" : $_ }
- grep { my $table = $_; !any { $_ eq $table } @{ $blacklist{$type} } }
- $db->list_tables;
+sub error {
+ print STDERR colored(shift, 'red'), $/;
+}
-} else {
- @tables = @ARGV;
+sub notice {
+ print @_, $/;
}
-foreach 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};
+parse_args(\%config);
+setup();
+my @tables = make_tables();
- process_table($table);
+my @unknown_tables = grep { !$package_names{KIVITENDO}->{$_} } @tables;
+if (@unknown_tables) {
+ error("The following tables do not have entries in \%SL::DB::Helper::Mappings::kivitendo_package_names: " . join(' ', sort @unknown_tables));
+ exit 1;
}
+
+process_table($_, $package_names{KIVITENDO}->{$_}) for @tables;
+
+1;
+
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+rose_auto_create_model - mana Rose::DB::Object classes for kivitendo
+
+=head1 SYNOPSIS
+
+ scripts/rose_create_model.pl --client name-or-id table1 [table2 ...]
+ scripts/rose_create_model.pl --client name-or-id [--all|-a]
+
+ # updates all models
+ scripts/rose_create_model.pl --client name-or-id --all
+
+ # updates only customer table, login taken from config
+ scripts/rose_create_model.pl customer
+
+ # updates only parts table, package will be Part
+ scripts/rose_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 parts
+
+=head1 DESCRIPTION
+
+Rose::DB::Object comes with a nice function named auto initialization with code
+generation. The documentation of Rose describes it like this:
+
+I<[...] auto-initializing metadata at runtime by querying the database has many
+caveats. An alternate approach is to query the database for metadata just once,
+and then generate the equivalent Perl code which can be pasted directly into
+the class definition in place of the call to auto_initialize.>
+
+I<Like the auto-initialization process itself, perl code generation has a
+convenient wrapper method as well as separate methods for the individual parts.
+All of the perl code generation methods begin with "perl_", and they support
+some rudimentary code formatting options to help the code conform to you
+preferred style. Examples can be found with the documentation for each perl_*
+method.>
+
+I<This hybrid approach to metadata population strikes a good balance between
+upfront effort and ongoing maintenance. Auto-generating the Perl code for the
+initial class definition saves a lot of tedious typing. From that point on,
+manually correcting and maintaining the definition is a small price to pay for
+the decreased start-up cost, the ability to use the class in the absence of a
+database connection, and the piece of mind that comes from knowing that your
+class is stable, and won't change behind your back in response to an "action at
+a distance" (i.e., a database schema update).>
+
+Unfortunately this reads easier than it is, since classes need to go into the
+right package and directory, certain stuff needs to be adjusted and table names
+need to be translated into their class names. This script will wrap all that
+behind a few simple options.
+
+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 three associated files. A C<SL::DB::MetaSetup::*>
+class, which is a perl version of the schema definition, a
+C<SL::DB::*> class file and a C<SL::DB::Manager::*> 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 OPTIONS
+
+=over 4
+
+=item C<--client, -c CLIENT>
+
+Provide a client whose database settings are used. If not present the
+client is loaded from the config key C<devel/client>. If that too is
+not found, an error is thrown.
+
+Note that C<CLIENT> 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<SL::DB::Helper::Mappings> are excluded.
+
+=item C<--no-commit, -n>
+
+=item C<--dry-run>
+
+Do not write back generated files. This will do everything as usual but not
+actually modify any file.
+
+=item C<--diff>
+
+Displays diff for selected file, if file is present and newer file is
+different. Beware, does not imply C<--no-commit>.
+
+=item C<--help, -h>
+
+Print this help.
+
+=item C<--quiet, -q>
+
+Does not print extra information, such as skipped files that were not
+changed and errors where the auto initialization failed.
+
+=back
+
+=head1 BUGS
+
+None yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
+
+=cut
projects / kivitendo-erp.git / blobdiff