package SQL::Translator::Utils;
# ----------------------------------------------------------------------
-# $Id: Utils.pm,v 1.6 2003-05-12 15:39:28 dlc Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2003 darren chamberlain <darren@cpan.org>
+# 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
use strict;
use base qw(Exporter);
use vars qw($VERSION $DEFAULT_COMMENT @EXPORT_OK);
-
+use Digest::SHA1 qw( sha1_hex );
use Exporter;
-$VERSION = 1.00;
+$VERSION = '1.59';
$DEFAULT_COMMENT = '-- ';
@EXPORT_OK = qw(
- debug normalize_name header_comment parse_list_arg $DEFAULT_COMMENT
+ debug normalize_name header_comment parse_list_arg truncate_id_uniquely
+ $DEFAULT_COMMENT parse_mysql_version parse_dbms_version
);
+use constant COLLISION_TAG_LENGTH => 8;
# ----------------------------------------------------------------------
# debug(@msg)
# ----------------------------------------------------------------------
sub normalize_name {
- my $name = shift;
+ my $name = shift or return '';
# The name can only begin with a-zA-Z_; if there's anything
# else, prefix with _
}
# ----------------------------------------------------------------------
-sub parse_list_arg {
- my $list = UNIVERSAL::isa( $_[0], 'ARRAY' ) ? shift : [ @_ ];
-
- return [ map { s/^\s+|\s+$//g; $_ }
- map { split /,/ }
- grep { defined } @$list
- ];
+# 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 protects stringification of references.
+ #
+ if ( @$list && ref $list->[0] ) {
+ return $list;
+ }
+ #
+ # This processes string-like arguments.
+ #
+ else {
+ 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 ) = @_;
+
+ return $desired_name
+ unless defined $desired_name && length $desired_name > $max_symbol_length;
+
+ my $truncated_name = substr $desired_name, 0,
+ $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;
+
+ return $truncated_name
+ . '_'
+ . $collision_tag;
+}
+
+
+#---------------------------------------------------------------------
+# 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) = @_;
+
+ return undef unless $v;
+
+ $target ||= 'perl';
+
+ my @vers;
+
+ # X.Y.Z style
+ if ( $v =~ / ^ (\d+) \. (\d{1,3}) (?: \. (\d{1,3}) )? $ /x ) {
+ push @vers, $1, $2, $3;
+ }
+
+ # XYYZZ (mysql) style
+ elsif ( $v =~ / ^ (\d) (\d{2}) (\d{2}) $ /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 MySQL version '$v'";
+ }
+
+ if ($target eq 'perl') {
+ return sprintf ('%d.%03d%03d', map { $_ || 0 } (@vers) );
+ }
+ elsif ($target eq 'mysql') {
+ return sprintf ('%d%02d%02d', map { $_ || 0 } (@vers) );
+ }
+ else {
+ #how do I croak sanely here?
+ die "Unknown version target '$target'";
+ }
+}
+
+#---------------------------------------------------------------------
+# parse_dbms_version ( $version_string, $target )
+#
+# Attempts to parse either a native or perl-style version string into
+# a version number format as specified by $target, which can be either
+# 'perl' for a perl-style version number, or 'native' for an X.X.X
+# style version number.
+#---------------------------------------------------------------------
+sub parse_dbms_version {
+ my ($v, $target) = @_;
+
+ return undef unless $v;
+
+ 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'";
+ }
}
1;
C<debug> takes 0 or more messages, which will be sent to STDERR using
C<warn>. Occurances of the strings I<PKG>, I<SUB>, and I<LINE>
will be replaced by the calling package, subroutine, and line number,
-respectively, as reported by C<caller(1)>.
+respectively, as reported by C<caller(1)>.
For example, from within C<foo> in F<SQL/Translator.pm>, at line 666:
use SQL::Translator::Utils qw(header_comment $DEFAULT_COMMENT);
print header_comment(__PACKAGE__,
- $DEFAULT_COMMENT,
+ $DEFAULT_COMMENT,
"Hi mom!");
produces:
- --
+ --
-- Created by My::Prodcuer
-- Created on Fri Apr 25 06:56:02 2003
- --
+ --
-- Hi mom!
- --
+ --
Note the gratuitous spacing.
parse_list_arg( [ 'id', 'name' ] );
parse_list_arg( qw[ id name ] );
+=head2 truncate_id_uniquely
+
+Takes a string ($desired_name) and int ($max_symbol_length). Truncates
+$desired_name to $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. For example,
+
+ truncate_id_uniquely( 'a' x 100, 64 )
+ truncate_id_uniquely( 'a' x 99 . 'b', 64 );
+ truncate_id_uniquely( 'a' x 99, 64 )
+
+Will give three different results; specifically:
+
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_7f900025
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_6191e39a
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_8cd96af2
+
=head2 $DEFAULT_COMMENT
This is the default comment string, '-- ' by default. Useful for
C<header_comment>.
+=head2 parse_mysql_version
+
+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
+version specifications:
+
+ 5.0.3
+ 4.1
+ 3.23.2
+ 5
+ 5.001005 (perl style)
+ 30201 (mysql style)
+
=head1 AUTHORS
Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
=cut
-
-=cut
projects / dbsrgits/SQL-Translator.git / blobdiff