6 unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
7 push @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version.
10 use CGI qw( -no_xhtml);
13 use Digest::MD5 qw(md5_hex);
14 use English qw( -no_match_vars );
16 use List::MoreUtils qw(any);
27 use SL::DB::Helper::ALL;
28 use SL::DB::Helper::Mappings;
30 my %blacklist = SL::DB::Helper::Mappings->get_blacklist;
31 my %package_names = SL::DB::Helper::Mappings->get_package_names;
37 our $script = __FILE__;
40 $OUTPUT_AUTOFLUSH = 1;
41 $Data::Dumper::Sortkeys = 1;
43 our $meta_path = "SL/DB/MetaSetup";
49 SL::LxOfficeConf->read;
51 my $login = $config{login} || $::lx_office_conf{devel}{login};
54 error("No login found in config. Please provide a login:");
58 $::lxdebug = LXDebug->new();
59 $::locale = Locale->new("de");
61 $::auth = SL::Auth->new();
62 $::user = User->new(login => $login);
63 %::myconfig = $auth->read_user(login => $login);
64 $::request = { cgi => CGI->new({}) };
65 $form->{script} = 'rose_meta_data.pl';
66 $form->{login} = $login;
68 map { $form->{$_} = $::myconfig{$_} } qw(stylesheet charset);
70 mkdir $meta_path unless -d $meta_path;
74 my @spec = split(/=/, shift, 2);
77 ($schema, $table) = split(m/\./, $table) if $table =~ m/\./;
78 my $package = ucfirst($spec[1] || $spec[0]);
79 $package =~ s/_+(.)/uc($1)/ge;
80 my $meta_file = "${meta_path}/${package}.pm";
81 my $file = "SL/DB/${package}.pm";
83 $schema = <<CODE if $schema;
84 __PACKAGE__->meta->schema('$schema');
87 my $definition = eval <<CODE;
88 package SL::DB::AUTO::$package;
90 use base qw(SL::DB::Object);
92 __PACKAGE__->meta->table('$table');
94 __PACKAGE__->meta->auto_initialize;
96 __PACKAGE__->meta->perl_class_definition(indent => 2); # , braces => 'bsd'
100 error("Error in execution for table '$table'");
101 error("'$EVAL_ERROR'") if $config{verbose};
105 $definition =~ s/::AUTO::/::/g;
106 my $full_definition = <<CODE;
107 # This file has been auto-generated. Do not modify it; it will be overwritten
108 # by $::script automatically.
112 my $meta_definition = <<CODE;
113 # This file has been auto-generated only because it didn't exist.
114 # Feel free to modify it at will; it will not be overwritten automatically.
116 package SL::DB::${package};
120 use SL::DB::MetaSetup::${package};
122 # Creates get_all, get_all_count, get_all_iterator, delete_all and update_all.
123 __PACKAGE__->meta->make_manager_class;
128 my $file_exists = -f $meta_file;
130 my $old_size = -s $meta_file;
131 my $orig_file = do { local(@ARGV, $/) = ($meta_file); <> };
132 my $old_md5 = md5_hex($orig_file);
133 my $new_size = length $full_definition;
134 my $new_md5 = md5_hex($full_definition);
135 if ($old_size == $new_size && $old_md5 == $new_md5) {
136 notice("No changes in $meta_file, skipping.") if $config{verbose};
140 show_diff(\$orig_file, \$full_definition) if $config{show_diff};
143 if (!$config{nocommit}) {
144 open my $out, ">", $meta_file || die;
145 print $out $full_definition;
148 notice("File '$meta_file' " . ($file_exists ? 'updated' : 'created') . " for table '$table'");
151 if (!$config{nocommit}) {
152 open my $out, ">", $file || die;
153 print $out $meta_definition;
156 notice("File '$file' created as well.");
163 'login|user=s' => \ my $login,
165 'no-commit|dry-run' => \ my $nocommit,
166 help => sub { pod2usage(verbose => 99, sections => 'NAME|SYNOPSIS|OPTIONS') },
167 verbose => \ my $verbose,
171 $options->{login} = $login if $login;
172 $options->{all} = $all;
173 $options->{nocommit} = $nocommit;
174 $options->{verbose} = $verbose;
177 if (eval { require Text::Diff; 1 }) {
178 $options->{show_diff} = 1;
180 error('Could not load Text::Diff. Sorry, no diffs for you.');
186 my ($text_a, $text_b) = @_;
193 Text::Diff::diff($text_a, $text_b, { OUTPUT => sub {
194 for (split /\n/, $_[0]) {
195 print colored($_, $colors{substr($_, 0, 1)}), $/;
201 pod2usage(verbose => 99, sections => 'SYNOPSIS');
207 my $db = SL::DB::create(undef, 'LXOFFICE');
209 map { $package_names{LXOFFICE}->{$_} ? "$_=" . $package_names{LXOFFICE}->{$_} : $_ }
210 grep { my $table = $_; !any { $_ eq $table } @{ $blacklist{LXOFFICE} } }
215 error("You specified neither --all nor any specific tables.");
223 print STDERR colored(shift, 'red'), $/;
230 parse_args(\%config);
232 my @tables = make_tables();
234 for my $table (@tables) {
235 # add default model name unless model name is given or no defaults exists
236 $table .= '=' . $package_names{LXOFFICE}->{lc $table} if $table !~ /=/ && $package_names{LXOFFICE}->{lc $table};
238 process_table($table);
249 rose_auto_create_model - mana Rose::DB::Object classes for kivitendo
253 scripts/rose_create_model.pl --login login table1[=package1] [table2[=package2] ...]
254 scripts/rose_create_model.pl --login login [--all|-a]
257 scripts/rose_create_model.pl --login login --all
259 # updates only customer table, login taken from config
260 scripts/rose_create_model.pl customer
262 # updates only parts table, package will be Part
263 scripts/rose_create_model.pl parts=Part
265 # try to update parts, but don't do it. tell what would happen in detail
266 scripts/rose_create_model.pl --no-commit --verbose parts
270 Rose::DB::Object comes with a nice function named auto initialization with code
271 generation. The documentation of Rose describes it like this:
273 I<[...] auto-initializing metadata at runtime by querying the database has many
274 caveats. An alternate approach is to query the database for metadata just once,
275 and then generate the equivalent Perl code which can be pasted directly into
276 the class definition in place of the call to auto_initialize.>
278 I<Like the auto-initialization process itself, perl code generation has a
279 convenient wrapper method as well as separate methods for the individual parts.
280 All of the perl code generation methods begin with "perl_", and they support
281 some rudimentary code formatting options to help the code conform to you
282 preferred style. Examples can be found with the documentation for each perl_*
285 I<This hybrid approach to metadata population strikes a good balance between
286 upfront effort and ongoing maintenance. Auto-generating the Perl code for the
287 initial class definition saves a lot of tedious typing. From that point on,
288 manually correcting and maintaining the definition is a small price to pay for
289 the decreased start-up cost, the ability to use the class in the absence of a
290 database connection, and the piece of mind that comes from knowing that your
291 class is stable, and won't change behind your back in response to an "action at
292 a distance" (i.e., a database schema update).>
294 Unfortunately this reads easier than it is, since classes need to go into the
295 right package and directory, certain stuff needs to be adjusted and table names
296 need to be translated into their class names. This script will wrap all that
297 behind a few simple options.
299 In the most basic version, just give it a login and a table name, and it will
300 load the schema information for this table and create the appropriate class
301 files, or update them if already present.
303 Each table has two associated files. A C<SL::DB::MetaSetup::*> class, which is
304 a perl version of the schema definition, and a C<SL::DB::*> class file. The
305 first one will be updated if the schema changes, the second one will only be
306 created if it does not exist.
312 =item C<--login, -l LOGIN>
314 =item C<--user, -u LOGIN>
316 Provide a login. If not present the login is loaded from the config key
317 C<devel/login>. If that too is not found, an error is thrown.
321 Process all tables from the database. Only those that are blacklistes in
322 L<SL::DB::Helper::Mappings> are excluded.
324 =item C<--no-commit, -n>
328 Do not write back generated files. This will do everything as usual but not
329 actually modify any file.
333 Displays diff for selected file, if file is present and newer file is
334 different. Beware, does not imply C<--no-commit>.
340 =item C<--verbose, -v>
342 Prints extra information, such as skipped files that were not changed and
343 errors where the auto initialization failed.
353 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>