package SQL::Translator::Utils;
-# ----------------------------------------------------------------------
-# Copyright (C) 2002-2009 SQLFairy Authors
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307 USA
-# -------------------------------------------------------------------
-
use strict;
+use warnings;
+use Digest::SHA qw( sha1_hex );
+use File::Spec;
+use Scalar::Util qw(blessed);
+use Try::Tiny;
+use Carp qw(carp croak);
+
+our $VERSION = '1.59';
+our $DEFAULT_COMMENT = '-- ';
+
use base qw(Exporter);
-use vars qw($VERSION $DEFAULT_COMMENT @EXPORT_OK);
-use Digest::SHA1 qw( sha1_hex );
-use Exporter;
-use Readonly;
-
-$VERSION = '1.60';
-$DEFAULT_COMMENT = '-- ';
-@EXPORT_OK = qw(
- debug normalize_name header_comment parse_list_arg truncate_id_uniquely $DEFAULT_COMMENT parse_mysql_version
+our @EXPORT_OK = qw(
+ debug normalize_name header_comment parse_list_arg truncate_id_uniquely
+ $DEFAULT_COMMENT parse_mysql_version parse_dbms_version
+ ddl_parser_instance batch_alter_table_statements
+ uniq throw ex2err carp_ro
+ normalize_quote_options
);
-Readonly my $COLLISION_TAG_LENGTH => 8;
-
-# ----------------------------------------------------------------------
-# debug(@msg)
-#
-# Will send debugging messages to STDERR, if the caller's $DEBUG global
-# is set.
-#
-# This debug() function has a neat feature: Occurances of the strings
-# PKG, LINE, and SUB in each message will be replaced with elements
-# from caller():
-#
-# debug("PKG: Bad things happened on line LINE!");
-#
-# Will be warned as:
-#
-# [SQL::Translator: Bad things happened on line 643]
-#
-# If called from Translator.pm, on line 643.
-# ----------------------------------------------------------------------
+use constant COLLISION_TAG_LENGTH => 8;
+
sub debug {
my ($pkg, $file, $line, $sub) = caller(0);
{
}
}
-# ----------------------------------------------------------------------
sub normalize_name {
my $name = shift or return '';
return $name;
}
-# ----------------------------------------------------------------------
+sub normalize_quote_options {
+ my $config = shift;
+
+ my $quote;
+ if (defined $config->{quote_identifiers}) {
+ $quote = $config->{quote_identifiers};
+
+ for (qw/quote_table_names quote_field_names/) {
+ carp "Ignoring deprecated parameter '$_', since 'quote_identifiers' is supplied"
+ if defined $config->{$_}
+ }
+ }
+ # Legacy one set the other is not
+ elsif (
+ defined $config->{'quote_table_names'}
+ xor
+ defined $config->{'quote_field_names'}
+ ) {
+ if (defined $config->{'quote_table_names'}) {
+ carp "Explicitly disabling the deprecated 'quote_table_names' implies disabling 'quote_identifiers' which in turn implies disabling 'quote_field_names'"
+ unless $config->{'quote_table_names'};
+ $quote = $config->{'quote_table_names'} ? 1 : 0;
+ }
+ else {
+ carp "Explicitly disabling the deprecated 'quote_field_names' implies disabling 'quote_identifiers' which in turn implies disabling 'quote_table_names'"
+ unless $config->{'quote_field_names'};
+ $quote = $config->{'quote_field_names'} ? 1 : 0;
+ }
+ }
+ # Legacy both are set
+ elsif(defined $config->{'quote_table_names'}) {
+ croak 'Setting quote_table_names and quote_field_names to conflicting values is no longer supported'
+ if ($config->{'quote_table_names'} xor $config->{'quote_field_names'});
+
+ $quote = $config->{'quote_table_names'} ? 1 : 0;
+ }
+
+ return $quote;
+}
+
sub header_comment {
my $producer = shift || caller;
my $comment_char = shift;
return $header_comment;
}
-# ----------------------------------------------------------------------
-# parse_list_arg
-#
-# Meant to accept a list, an array reference, or a string of
-# comma-separated values. Retuns an array reference of the
-# arguments. Modified to also handle a list of references.
-# ----------------------------------------------------------------------
sub parse_list_arg {
my $list = UNIVERSAL::isa( $_[0], 'ARRAY' ) ? shift : [ @_ ];
# This processes string-like arguments.
#
else {
- return [
+ return [
map { s/^\s+|\s+$//g; $_ }
map { split /,/ }
grep { defined && length } @$list
}
}
-# ----------------------------------------------------------------------
-# truncate_id_uniquely( $desired_name, $max_symbol_length )
-#
-# Truncates the name $desired_name to the $max_symbol_length by
-# including part of the hash of the full name at the end of the
-# truncated name, giving a high probability that the symbol will be
-# unique.
-# ----------------------------------------------------------------------
sub truncate_id_uniquely {
my ( $desired_name, $max_symbol_length ) = @_;
unless defined $desired_name && length $desired_name > $max_symbol_length;
my $truncated_name = substr $desired_name, 0,
- $max_symbol_length - $COLLISION_TAG_LENGTH - 1;
+ $max_symbol_length - COLLISION_TAG_LENGTH - 1;
# Hex isn't the most space-efficient, but it skirts around allowed
# charset issues
my $digest = sha1_hex($desired_name);
- my $collision_tag = substr $digest, 0, $COLLISION_TAG_LENGTH;
+ my $collision_tag = substr $digest, 0, COLLISION_TAG_LENGTH;
return $truncated_name
. '_'
}
-#---------------------------------------------------------------------
-# parse_mysql_version ( $version_string, $result_target)
-#
-# Attempts to parse an arbitrary string as a mysql version number.
-# Returns either a floating point perl style string, or a mysql style
-# 5 digit string, depending on the supplied $result_target
-#---------------------------------------------------------------------
sub parse_mysql_version {
my ($v, $target) = @_;
my @vers;
- # X.Y.Z style
+ # X.Y.Z style
if ( $v =~ / ^ (\d+) \. (\d{1,3}) (?: \. (\d{1,3}) )? $ /x ) {
push @vers, $1, $2, $3;
}
- # XYYZZ (mysql) style
+ # XYYZZ (mysql) style
elsif ( $v =~ / ^ (\d) (\d{2}) (\d{2}) $ /x ) {
push @vers, $1, $2, $3;
}
- # XX.YYYZZZ (perl) style or simply X
+ # XX.YYYZZZ (perl) style or simply X
elsif ( $v =~ / ^ (\d+) (?: \. (\d{3}) (\d{3}) )? $ /x ) {
push @vers, $1, $2, $3;
}
}
}
+sub parse_dbms_version {
+ my ($v, $target) = @_;
+
+ return undef unless $v;
-1;
+ my @vers;
+
+ # X.Y.Z style
+ if ( $v =~ / ^ (\d+) \. (\d{1,3}) (?: \. (\d{1,3}) )? $ /x ) {
+ push @vers, $1, $2, $3;
+ }
-# ----------------------------------------------------------------------
+ # XX.YYYZZZ (perl) style or simply X
+ elsif ( $v =~ / ^ (\d+) (?: \. (\d{3}) (\d{3}) )? $ /x ) {
+ push @vers, $1, $2, $3;
+ }
+ else {
+ #how do I croak sanely here?
+ die "Unparseable database server version '$v'";
+ }
+
+ if ($target eq 'perl') {
+ return sprintf ('%d.%03d%03d', map { $_ || 0 } (@vers) );
+ }
+ elsif ($target eq 'native') {
+ return join '.' => grep defined, @vers;
+ }
+ else {
+ #how do I croak sanely here?
+ die "Unknown version target '$target'";
+ }
+}
+
+#my ($parsers_libdir, $checkout_dir);
+sub ddl_parser_instance {
+
+ my $type = shift;
+
+ # it may differ from our caller, even though currently this is not the case
+ eval "require SQL::Translator::Parser::$type"
+ or die "Unable to load grammar-spec container SQL::Translator::Parser::$type:\n$@";
+
+ # handle DB2 in a special way, since the grammar source was lost :(
+ if ($type eq 'DB2') {
+ require SQL::Translator::Parser::DB2::Grammar;
+ return SQL::Translator::Parser::DB2::Grammar->new;
+ }
+
+ require Parse::RecDescent;
+ return Parse::RecDescent->new(do {
+ no strict 'refs';
+ ${"SQL::Translator::Parser::${type}::GRAMMAR"}
+ || die "No \$SQL::Translator::Parser::${type}::GRAMMAR defined, unable to instantiate PRD parser\n"
+ });
+
+# this is disabled until RT#74593 is resolved
+
+=begin sadness
+
+ unless ($parsers_libdir) {
+
+ # are we in a checkout?
+ if ($checkout_dir = _find_co_root()) {
+ $parsers_libdir = File::Spec->catdir($checkout_dir, 'share', 'PrecompiledParsers');
+ }
+ else {
+ require File::ShareDir;
+ $parsers_libdir = File::Spec->catdir(
+ File::ShareDir::dist_dir('SQL-Translator'),
+ 'PrecompiledParsers'
+ );
+ }
+
+ unshift @INC, $parsers_libdir;
+ }
+
+ my $precompiled_mod = "Parse::RecDescent::DDL::SQLT::$type";
+
+ # FIXME FIXME FIXME
+ # Parse::RecDescent has horrible architecture where each precompiled parser
+ # instance shares global state with all its siblings
+ # What we do here is gross, but scarily efficient - the parser compilation
+ # is much much slower than an unload/reload cycle
+ require Class::Unload;
+ Class::Unload->unload($precompiled_mod);
+
+ # There is also a sub-namespace that P::RD uses, but simply unsetting
+ # $^W to stop redefine warnings seems to be enough
+ #Class::Unload->unload("Parse::RecDescent::$precompiled_mod");
+
+ eval "local \$^W; require $precompiled_mod" or do {
+ if ($checkout_dir) {
+ die "Unable to find precompiled grammar for $type - run Makefile.PL to generate it\n";
+ }
+ else {
+ die "Unable to load precompiled grammar for $type... this is not supposed to happen if you are not in a checkout, please file a bugreport:\n$@"
+ }
+ };
+
+ my $grammar_spec_fn = $INC{"SQL/Translator/Parser/$type.pm"};
+ my $precompiled_fn = $INC{"Parse/RecDescent/DDL/SQLT/$type.pm"};
+
+ if (
+ (stat($grammar_spec_fn))[9]
+ >
+ (stat($precompiled_fn))[9]
+ ) {
+ die (
+ "Grammar spec '$grammar_spec_fn' is newer than precompiled parser '$precompiled_fn'"
+ . ($checkout_dir
+ ? " - run Makefile.PL to regenerate stale versions\n"
+ : "... this is not supposed to happen if you are not in a checkout, please file a bugreport\n"
+ )
+ );
+ }
+
+ return $precompiled_mod->new;
+
+=end sadness
+
+=cut
+
+}
+
+# Try to determine the root of a checkout/untar if possible
+# or return undef
+sub _find_co_root {
+
+ my @mod_parts = split /::/, (__PACKAGE__ . '.pm');
+ my $rel_path = join ('/', @mod_parts); # %INC stores paths with / regardless of OS
+
+ return undef unless ($INC{$rel_path});
+
+ # a bit convoluted, but what we do here essentially is:
+ # - get the file name of this particular module
+ # - do 'cd ..' as many times as necessary to get to lib/SQL/Translator/../../..
+
+ my $root = (File::Spec::Unix->splitpath($INC{$rel_path}))[1];
+ for (1 .. @mod_parts) {
+ $root = File::Spec->catdir($root, File::Spec->updir);
+ }
+
+ return ( -f File::Spec->catfile($root, 'Makefile.PL') )
+ ? $root
+ : undef
+ ;
+}
+
+{
+ package SQL::Translator::Utils::Error;
+
+ use overload
+ '""' => sub { ${$_[0]} },
+ fallback => 1;
+
+ sub new {
+ my ($class, $msg) = @_;
+ bless \$msg, $class;
+ }
+}
+
+sub uniq {
+ my( %seen, $seen_undef, $numeric_preserving_copy );
+ grep { not (
+ defined $_
+ ? $seen{ $numeric_preserving_copy = $_ }++
+ : $seen_undef++
+ ) } @_;
+}
+
+sub throw {
+ die SQL::Translator::Utils::Error->new($_[0]);
+}
+
+sub ex2err {
+ my ($orig, $self, @args) = @_;
+ return try {
+ $self->$orig(@args);
+ } catch {
+ die $_ unless blessed($_) && $_->isa("SQL::Translator::Utils::Error");
+ $self->error("$_");
+ };
+}
+
+sub carp_ro {
+ my ($name) = @_;
+ return sub {
+ my ($orig, $self) = (shift, shift);
+ carp "'$name' is a read-only accessor" if @_;
+ return $self->$orig;
+ };
+}
+
+sub batch_alter_table_statements {
+ my ($diff_hash, $options, @meths) = @_;
+
+ @meths = qw(
+ rename_table
+ alter_drop_constraint
+ alter_drop_index
+ drop_field
+ add_field
+ alter_field
+ rename_field
+ alter_create_index
+ alter_create_constraint
+ alter_table
+ ) unless @meths;
+
+ my $package = caller;
+
+ return map {
+ my $meth = $package->can($_) or die "$package cant $_";
+ map { $meth->(ref $_ eq 'ARRAY' ? @$_ : $_, $options) } @{ $diff_hash->{$_} }
+ } grep { @{$diff_hash->{$_} || []} }
+ @meths;
+}
+
+1;
=pod
=head2 parse_mysql_version
-Used by both L<Parser::MySQL|SQL::Translator::Parser::MySQL> and
+Used by both L<Parser::MySQL|SQL::Translator::Parser::MySQL> and
L<Producer::MySQL|SQL::Translator::Producer::MySQL> in order to provide a
consistent format for both C<< parser_args->{mysql_parser_version} >> and
C<< producer_args->{mysql_version} >> respectively. Takes any of the following
5.001005 (perl style)
30201 (mysql style)
+=head2 parse_dbms_version
+
+Takes a version string (X.Y.Z) or perl style (XX.YYYZZZ) and a target ('perl'
+or 'native') transforms the string to the given target style.
+to
+
+=head2 throw
+
+Throws the provided string as an object that will stringify back to the
+original string. This stops it from being mangled by L<Moo>'s C<isa>
+code.
+
+=head2 ex2err
+
+Wraps an attribute accessor to catch any exception raised using
+L</throw> and store them in C<< $self->error() >>, finally returning
+undef. A reference to this function can be passed directly to
+L<Moo/around>.
+
+ around foo => \&ex2err;
+
+ around bar => sub {
+ my ($orig, $self) = (shift, shift);
+ return ex2err($orig, $self, @_) if @_;
+ ...
+ };
+
+=head2 carp_ro
+
+Takes a field name and returns a reference to a function can be used
+L<around|Moo/around> a read-only accessor to make it L<carp|Carp>
+instead of die when passed an argument.
+
+=head2 batch_alter_table_statements
+
+Takes diff and argument hashes as passed to
+L<batch_alter_table|SQL::Translator::Diff/batch_alter_table($table, $hash, $args) (optional)>
+and an optional list of producer functions to call on the calling package.
+Returns the list of statements returned by the producer functions.
+
+If no producer functions are specified, the following functions in the
+calling package are called:
+
+=over
+
+=item 1. rename_table
+
+=item 2. alter_drop_constraint
+
+=item 3. alter_drop_index
+
+=item 4. drop_field
+
+=item 5. add_field
+
+=item 5. alter_field
+
+=item 6. rename_field
+
+=item 7. alter_create_index
+
+=item 8. alter_create_constraint
+
+=item 9. alter_table
+
+=back
+
+If the corresponding array in the hash has any elements, but the
+caller doesn't implement that function, an exception is thrown.
+
=head1 AUTHORS
Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
-Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
=cut
projects / dbsrgits/SQL-Translator.git / blobdiff