#!/usr/bin/env perl
#------------------------------------------------------------------------------
#
# pgBadger - Advanced PostgreSQL log analyzer
#
# This program is open source, licensed under the PostgreSQL Licence.
# For license terms, see the LICENSE file.
#------------------------------------------------------------------------------
#
# Settings in postgresql.conf
#
# You should enable SQL query logging with log_min_duration_statement >= 0
# With stderr output
# Log line prefix should be: log_line_prefix = '%t [%p]: '
# Log line prefix should be: log_line_prefix = '%t [%p]: user=%u,db=%d '
# Log line prefix should be: log_line_prefix = '%t [%p]: db=%d,user=%u '
# If you need report per client Ip adresses you can add client=%h or remote=%h
# pgbadger will also recognized the following form:
# log_line_prefix = '%t [%p]: db=%d,user=%u,client=%h '
# or
# log_line_prefix = '%t [%p]: user=%u,db=%d,remote=%h '
# With syslog output
# Log line prefix should be: log_line_prefix = 'db=%d,user=%u '
#
# Additional information that could be collected and reported
# log_checkpoints = on
# log_connections = on
# log_disconnections = on
# log_lock_waits = on
# log_temp_files = 0
# log_autovacuum_min_duration = 0
#------------------------------------------------------------------------------
use vars qw($VERSION);
use strict qw(vars subs);
use Getopt::Long qw(:config no_ignore_case bundling);
use IO::File;
use Benchmark;
use File::Basename;
use Storable qw(store_fd fd_retrieve);
use Time::Local qw(timegm_nocheck timelocal_nocheck timegm timelocal);
use POSIX qw(locale_h sys_wait_h _exit strftime);
setlocale(LC_NUMERIC, '');
setlocale(LC_ALL, 'C');
use File::Spec;
use File::Temp qw/ tempfile /;
use IO::Handle;
use IO::Pipe;
use FileHandle;
use Socket;
use constant EBCDIC => "\t" ne "\011";
use Encode qw(encode decode);
$VERSION = '13.2';
$SIG{'CHLD'} = 'DEFAULT';
my $TMP_DIR = File::Spec->tmpdir() || '/tmp';
my %RUNNING_PIDS = ();
my @tempfiles = ();
my $parent_pid = $$;
my $interrupt = 0;
my $tmp_last_parsed = '';
my $tmp_dblist = '';
my @SQL_ACTION = ('SELECT', 'INSERT', 'UPDATE', 'DELETE', 'COPY FROM', 'COPY TO', 'CTE', 'DDL', 'TCL', 'CURSOR');
my @LATENCY_PERCENTILE = sort {$a <=> $b} (99,95,90);
my $graphid = 1;
my $NODATA = '
NO DATASET
';
my $MAX_QUERY_LENGTH = 25000;
my $terminate = 0;
my %CACHE_DNS = ();
my $DNSLookupTimeout = 1; # (in seconds)
my $EXPLAIN_URL = 'https://explain.depesz.com/';
my $EXPLAIN_POST = qq{};
my $PID_DIR = $TMP_DIR;
my $PID_FILE = undef;
my %DBLIST = ();
my $DBALL = 'postgres';
my $LOG_EOL_TYPE = 'LF';
# Factor used to estimate the total size of compressed file
# when real size can not be obtained (bz2 or remote files)
my $BZ_FACTOR = 30;
my $GZ_FACTOR = 15;
my $XZ_FACTOR = 18;
my @E2A = (
0, 1, 2, 3,156, 9,134,127,151,141,142, 11, 12, 13, 14, 15,
16, 17, 18, 19,157, 10, 8,135, 24, 25,146,143, 28, 29, 30, 31,
128,129,130,131,132,133, 23, 27,136,137,138,139,140, 5, 6, 7,
144,145, 22,147,148,149,150, 4,152,153,154,155, 20, 21,158, 26,
32,160,226,228,224,225,227,229,231,241,162, 46, 60, 40, 43,124,
38,233,234,235,232,237,238,239,236,223, 33, 36, 42, 41, 59, 94,
45, 47,194,196,192,193,195,197,199,209,166, 44, 37, 95, 62, 63,
248,201,202,203,200,205,206,207,204, 96, 58, 35, 64, 39, 61, 34,
216, 97, 98, 99,100,101,102,103,104,105,171,187,240,253,254,177,
176,106,107,108,109,110,111,112,113,114,170,186,230,184,198,164,
181,126,115,116,117,118,119,120,121,122,161,191,208, 91,222,174,
172,163,165,183,169,167,182,188,189,190,221,168,175, 93,180,215,
123, 65, 66, 67, 68, 69, 70, 71, 72, 73,173,244,246,242,243,245,
125, 74, 75, 76, 77, 78, 79, 80, 81, 82,185,251,252,249,250,255,
92,247, 83, 84, 85, 86, 87, 88, 89, 90,178,212,214,210,211,213,
48, 49, 50, 51, 52, 53, 54, 55, 56, 57,179,219,220,217,218,159
);
if (EBCDIC && ord('^') == 106) { # as in the BS2000 posix-bc coded character set
$E2A[74] = 96; $E2A[95] = 159; $E2A[106] = 94; $E2A[121] = 168;
$E2A[161] = 175; $E2A[173] = 221; $E2A[176] = 162; $E2A[186] = 172;
$E2A[187] = 91; $E2A[188] = 92; $E2A[192] = 249; $E2A[208] = 166;
$E2A[221] = 219; $E2A[224] = 217; $E2A[251] = 123; $E2A[253] = 125;
$E2A[255] = 126;
}
elsif (EBCDIC && ord('^') == 176) { # as in codepage 037 on os400
$E2A[21] = 133; $E2A[37] = 10; $E2A[95] = 172; $E2A[173] = 221;
$E2A[176] = 94; $E2A[186] = 91; $E2A[187] = 93; $E2A[189] = 168;
}
my $pgbadger_logo =
'';
my $pgbadger_ico =
'data:image/x-icon;base64,
AAABAAEAIyMQAAEABAA8BAAAFgAAACgAAAAjAAAARgAAAAEABAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAgAAGRsZACgqKQA2OTcASEpJAFpdWwBoa2kAeHt5AImMigCeoZ8AsLOxAMTHxQDR1NIA
5enmAPv+/AAAAAAA///////////////////////wAAD///////////H///////////AAAP//////
//9Fq7Yv////////8AAA////////8V7u7qD////////wAAD///////8B7qWN5AL///////AAAP//
///y8Avrc3rtMCH/////8AAA/////xABvbAAAJ6kAA/////wAAD////wAG5tQAAADp6RAP////AA
AP//MQBd7C2lRESOWe5xAD//8AAA//8APO7iC+7e7u4A3uxwBf/wAAD/9Aju7iAAvu7u0QAN7ukA
7/AAAP/wCe7kAAAF7ugAAAHO6xD/8AAA//AK7CAAAAHO1AAAABnrEP/wAAD/8ArAAAAAAc7kAAAA
AIwQ//AAAP/wCjAAAAAC3uQAAAAAHBCf8AAA//AIEBVnIATu5gAXZhAFEP/wAAD/8AIAqxdwBu7p
AFoX0QIQ//AAAP/wAAPsBCAL7u4QBwfmAAD/8AAA//AAA8owAC7u7lAAKbYAAJ/wAAD/8AAAAAAA
fu7uwAAAAAAA//AAAP/wAAAAAADu7u7jAAAAAAD/8AAA//AAAAAABe7u7uoAAAAAAP/wAAD/8AAA
AAAL7u7u7QAAAAAAn/AAAP/wAAAAAB3u7u7uYAAAAAD/8AAA//MAAAAATu7u7u6QAAAAAP/wAAD/
/wAAAAAM7u7u7TAAAAAD//AAAP//IQAAAAKu7u7UAAAAAB//8AAA////IAAAAAju7BAAAAAP///w
AAD////2AAA1je7ulUAAA/////AAAP/////xEAnO7u7pIAH/////8AAA//////9CABju6iACP///
///wAAD////////wAAggAP////////AAAP////////8wAAA/////////8AAA///////////w////
///////wAAD///////////////////////AAAP/////gAAAA//+//+AAAAD//Af/4AAAAP/4A//g
AAAA//AA/+AAAAD/oAA/4AAAAP8AAB/gAAAA/gAAD+AAAADwAAAB4AAAAPAAAADgAAAA4AAAAGAA
AADgAAAA4AAAAOAAAADgAAAA4AAAAOAAAADgAAAAYAAAAOAAAADgAAAA4AAAAOAAAADgAAAA4AAA
AOAAAABgAAAA4AAAAOAAAADgAAAA4AAAAOAAAADgAAAA4AAAAGAAAADgAAAA4AAAAOAAAADgAAAA
8AAAAOAAAADwAAAB4AAAAPwAAAfgAAAA/gAAD+AAAAD/gAA/4AAAAP/AAH/gAAAA//gD/+AAAAD/
/Af/4AAAAP//v//gAAAA/////+AAAAA
';
my %CLASS_ERROR_CODE = (
'00' => 'Successful Completion',
'01' => 'Warning',
'02' => 'No Data (this is also a warning class per the SQL standard)',
'03' => 'SQL Statement Not Yet Complete',
'08' => 'Connection Exception',
'09' => 'Triggered Action Exception',
'0A' => 'Feature Not Supported',
'0B' => 'Invalid Transaction Initiation',
'0F' => 'Locator Exception',
'0L' => 'Invalid Grantor',
'0P' => 'Invalid Role Specification',
'0Z' => 'Diagnostics Exception',
'20' => 'Case Not Found',
'21' => 'Cardinality Violation',
'22' => 'Data Exception',
'23' => 'Integrity Constraint Violation',
'24' => 'Invalid Cursor State',
'25' => 'Invalid Transaction State',
'26' => 'Invalid SQL Statement Name',
'27' => 'Triggered Data Change Violation',
'28' => 'Invalid Authorization Specification',
'2B' => 'Dependent Privilege Descriptors Still Exist',
'2D' => 'Invalid Transaction Termination',
'2F' => 'SQL Routine Exception',
'34' => 'Invalid Cursor Name',
'38' => 'External Routine Exception',
'39' => 'External Routine Invocation Exception',
'3B' => 'Savepoint Exception',
'3D' => 'Invalid Catalog Name',
'3F' => 'Invalid Schema Name',
'40' => 'Transaction Rollback',
'42' => 'Syntax Error or Access Rule Violation',
'44' => 'WITH CHECK OPTION Violation',
'53' => 'Insufficient Resources',
'54' => 'Program Limit Exceeded',
'55' => 'Object Not In Prerequisite State',
'57' => 'Operator Intervention',
'58' => 'System Error (errors external to PostgreSQL itself)',
'72' => 'Snapshot Failure',
'F0' => 'Configuration File Error',
'HV' => 'Foreign Data Wrapper Error (SQL/MED)',
'P0' => 'PL/pgSQL Error',
'XX' => 'Internal Error',
);
####
# method used to fork as many child as wanted
##
sub spawn
{
my $coderef = shift;
unless (@_ == 0 && $coderef && ref($coderef) eq 'CODE') {
print "usage: spawn CODEREF";
exit 0;
}
my $pid;
if (!defined($pid = fork)) {
print STDERR "ERROR: cannot fork: $!\n";
return;
} elsif ($pid) {
$RUNNING_PIDS{$pid} = $pid;
return; # the parent
}
# the child -- go spawn
$< = $>;
$( = $); # suid progs only
exit &$coderef();
}
# Command line options
my $journalctl_cmd = '';
my $zcat_cmd = 'gunzip -c';
my $zcat = $zcat_cmd;
my $bzcat = 'bunzip2 -c';
my $lz4cat = 'lz4cat';
my $ucat = 'unzip -p';
my $xzcat = 'xzcat';
my $zstdcat = 'zstdcat';
my $gzip_uncompress_size = "gunzip -l \"%f\" | grep -E '^\\s*[0-9]+' | awk '{print \$2}'";
# lz4 archive can only contain one file.
# Original size can be retrieved only if --content-size has been used for compression
# it seems lz4 send output to stderr so redirect to stdout
my $lz4_uncompress_size = " lz4 -v -c --list %f 2>&1 |tail -n 2|head -n1 | awk '{print \$6}'";
my $zip_uncompress_size = "unzip -l %f | awk '{if (NR==4) print \$1}'";
my $xz_uncompress_size = "xz --robot -l %f | grep totals | awk '{print \$5}'";
my $zstd_uncompress_size = "zstd -v -l %f |grep Decompressed | awk -F\"[ (]*\" '{print \$5}'";
my $format = '';
my @outfiles = ();
my $outdir = '';
my $incremental = '';
my $extra_files = 0;
my $help = '';
my $ver = '';
my @dbname = ();
my @dbuser = ();
my @dbclient = ();
my @dbappname = ();
my @exclude_user = ();
my @exclude_appname = ();
my @exclude_db = ();
my @exclude_client = ();
my @exclude_line = ();
my $ident = '';
my $top = 0;
my $sample = 3;
my $extension = '';
my $maxlength = 100000;
my $graph = 1;
my $nograph = 0;
my $debug = 0;
my $noprettify = 0;
my $from = '';
my $to = '';
my $from_hour = '';
my $to_hour = '';
my $quiet = 0;
my $progress = 1;
my $error_only = 0;
my @exclude_query = ();
my @exclude_queryid = ();
my @exclude_time = ();
my @include_time = ();
my $exclude_file = '';
my @include_query = ();
my $include_file = '';
my $disable_error = 0;
my $disable_hourly = 0;
my $disable_type = 0;
my $disable_query = 0;
my $disable_session = 0;
my $disable_connection = 0;
my $disable_lock = 0;
my $disable_temporary = 0;
my $disable_checkpoint = 0;
my $disable_autovacuum = 0;
my $avg_minutes = 5;
my $histo_avg_minutes = 60;
my $last_parsed = '';
my $report_title = '';
my $log_line_prefix = '';
my $compiled_prefix = '';
my $project_url = 'http://pgbadger.darold.net/';
my $t_min = 0;
my $t_max = 0;
my $remove_comment = 0;
my $select_only = 0;
my $queue_size = 0;
my $job_per_file = 0;
my $charset = 'utf-8';
my $csv_sep_char = ',';
my %current_sessions = ();
my %pgb_current_sessions = ();
my $incr_date = '';
my $last_incr_date = '';
my $anonymize = 0;
my $noclean = 0;
my $retention = 0;
my $dns_resolv = 0;
my $nomultiline = 0;
my $noreport = 0;
my $log_duration = 0;
my $logfile_list = '';
my $enable_checksum = 0;
my $timezone = 0;
my $opt_timezone = 0;
my $pgbouncer_only = 0;
my $rebuild = 0;
my $week_start_monday = 0;
my $iso_week_number = 0;
my $use_sessionid_as_pid = 0;
my $dump_normalized_only = 0;
my $log_timezone = 0;
my $opt_log_timezone = 0;
my $json_prettify = 0;
my $report_per_database = 0;
my $html_outdir = '';
my $param_size_limit = 24;
my $month_report = 0;
my $day_report = 0;
my $noexplain = 0;
my $log_command = '';
my $wide_char = 0;
my $noweekreport = 0;
my $query_numbering = 0;
my $keep_comments = 0;
my $no_progessbar = 0;
my $NUMPROGRESS = 10;
my @DIMENSIONS = (800, 300);
my $RESRC_URL = '';
my $img_format = 'png';
my @log_files = ();
my %prefix_vars = ();
my $q_prefix = '';
my @prefix_q_params = ();
my %last_execute_stmt = ();
my $disable_process_title = 0;
my $dump_all_queries = 0;
my $dump_raw_csv = 0;
my $header_done = 0;
my @include_pid = ();
my @include_session = ();
my $compress_extensions = qr/\.(zip|gz|xz|bz2|lz4|zst)$/i;
my $remote_host = '';
my $ssh_command = '';
my $ssh_bin = 'ssh';
my $ssh_port = 22;
my $ssh_identity = '';
my $ssh_user = '';
my $ssh_timeout = 10;
my $ssh_options = "-o ConnectTimeout=$ssh_timeout -o PreferredAuthentications=hostbased,publickey";
my $ssh_sudo = 0;
my $force_sample = 0;
my $nofork = 0;
my $curl_command = 'curl -k -s ';
my $sql_prettified = pgFormatter::Beautify->new('colorize' => 1, 'format' => 'html', 'uc_keywords' => 0);
# Flag for logs using UTC, in this case we don't autodetect the timezone
my $isUTC = 0;
# Do not display data in pie where percentage is lower than this value
# to avoid label overlapping.
my $pie_percentage_limit = 2;
# Get the decimal separator
my $n = 5 / 2;
my $num_sep = ',';
$num_sep = ' ' if ($n =~ /,/);
# Set iso datetime pattern
my $time_pattern = qr/(\d{4})-(\d{2})-(\d{2})[\sT](\d{2}):(\d{2}):(\d{2})/;
# Inform the parent that it should stop iterate on parsing other files
sub stop_parsing
{
&logmsg('DEBUG', "Received interrupt signal");
$interrupt = 1;
}
# With multiprocess we need to wait for all children
sub wait_child
{
my $sig = shift;
$interrupt = 2;
print STDERR "Received terminating signal ($sig).\n";
1 while wait != -1;
$SIG{INT} = \&wait_child;
$SIG{TERM} = \&wait_child;
foreach my $f (@tempfiles)
{
unlink("$f->[1]") if (-e "$f->[1]");
}
if ($report_per_database)
{
unlink("$tmp_dblist");
}
if ($last_parsed && -e "$tmp_last_parsed")
{
unlink("$tmp_last_parsed");
}
if ($last_parsed && -e "$last_parsed.tmp")
{
unlink("$last_parsed.tmp");
}
if (-e "$PID_FILE")
{
unlink("$PID_FILE");
}
_exit(2);
}
$SIG{INT} = \&wait_child;
$SIG{TERM} = \&wait_child;
if ($^O !~ /MSWin32|dos/i) {
$SIG{USR2} = \&stop_parsing;
} else {
$nofork = 1;
}
$| = 1;
my $histogram_query = '';
my $histogram_session = '';
# get the command line parameters
my $result = GetOptions(
"a|average=i" => \$avg_minutes,
"A|histo-average=i" => \$histo_avg_minutes,
"b|begin=s" => \$from,
"c|dbclient=s" => \@dbclient,
"C|nocomment!" => \$remove_comment,
"d|dbname=s" => \@dbname,
"D|dns-resolv!" => \$dns_resolv,
"e|end=s" => \$to,
"E|explode!" => \$report_per_database,
"f|format=s" => \$format,
"G|nograph!" => \$nograph,
"h|help!" => \$help,
"H|html-outdir=s" => \$html_outdir,
"i|ident=s" => \$ident,
"I|incremental!" => \$incremental,
"j|jobs=i" => \$queue_size,
"J|Jobs=i" => \$job_per_file,
"l|last-parsed=s" => \$last_parsed,
"L|logfile-list=s" => \$logfile_list,
"m|maxlength=i" => \$maxlength,
"M|no-multiline!" => \$nomultiline,
"N|appname=s" => \@dbappname,
"o|outfile=s" => \@outfiles,
"O|outdir=s" => \$outdir,
"p|prefix=s" => \$log_line_prefix,
"P|no-prettify!" => \$noprettify,
"q|quiet!" => \$quiet,
"Q|query-numbering!" => \$query_numbering,
"r|remote-host=s" => \$remote_host,
'R|retention=i' => \$retention,
"s|sample=i" => \$sample,
"S|select-only!" => \$select_only,
"t|top=i" => \$top,
"T|title=s" => \$report_title,
"u|dbuser=s" => \@dbuser,
"U|exclude-user=s" => \@exclude_user,
"v|verbose!" => \$debug,
"V|version!" => \$ver,
"w|watch-mode!" => \$error_only,
"W|wide-char!" => \$wide_char,
"x|extension=s" => \$extension,
"X|extra-files!" => \$extra_files,
"z|zcat=s" => \$zcat,
"Z|timezone=f" => \$opt_timezone,
"pie-limit=i" => \$pie_percentage_limit,
"image-format=s" => \$img_format,
"exclude-query=s" => \@exclude_query,
"exclude-queryid=s" => \@exclude_queryid,
"exclude-file=s" => \$exclude_file,
"exclude-db=s" => \@exclude_db,
"exclude-client=s" => \@exclude_client,
"exclude-appname=s" => \@exclude_appname,
"include-query=s" => \@include_query,
"exclude-line=s" => \@exclude_line,
"include-file=s" => \$include_file,
"disable-error!" => \$disable_error,
"disable-hourly!" => \$disable_hourly,
"disable-type!" => \$disable_type,
"disable-query!" => \$disable_query,
"disable-session!" => \$disable_session,
"disable-connection!" => \$disable_connection,
"disable-lock!" => \$disable_lock,
"disable-temporary!" => \$disable_temporary,
"disable-checkpoint!" => \$disable_checkpoint,
"disable-autovacuum!" => \$disable_autovacuum,
"charset=s" => \$charset,
"csv-separator=s" => \$csv_sep_char,
"include-time=s" => \@include_time,
"exclude-time=s" => \@exclude_time,
'ssh-command=s' => \$ssh_command,
'ssh-program=s' => \$ssh_bin,
'ssh-port=i' => \$ssh_port,
'ssh-identity=s' => \$ssh_identity,
'ssh-option=s' => \$ssh_options,
'ssh-sudo!' => \$ssh_sudo,
'ssh-user=s' => \$ssh_user,
'ssh-timeout=i' => \$ssh_timeout,
'anonymize!' => \$anonymize,
'noclean!' => \$noclean,
'noreport!' => \$noreport,
'log-duration!' => \$log_duration,
'enable-checksum!' => \$enable_checksum,
'journalctl=s' => \$journalctl_cmd,
'pid-dir=s' => \$PID_DIR,
'pid-file=s' => \$PID_FILE,
'rebuild!' => \$rebuild,
'pgbouncer-only!' => \$pgbouncer_only,
'start-monday!' => \$week_start_monday,
'iso-week-number!' => \$iso_week_number,
'normalized-only!' => \$dump_normalized_only,
'log-timezone=f' => \$opt_log_timezone,
'prettify-json!' => \$json_prettify,
'month-report=s' => \$month_report,
'day-report=s' => \$day_report,
'noexplain!' => \$noexplain,
'command=s' => \$log_command,
'no-week!' => \$noweekreport,
'explain-url=s' => \$EXPLAIN_URL,
'tempdir=s' => \$TMP_DIR,
'no-process-info!' => \$disable_process_title,
'dump-all-queries!' => \$dump_all_queries,
'keep-comments!' => \$keep_comments,
'no-progressbar!' => \$no_progessbar,
'dump-raw-csv!' => \$dump_raw_csv,
'include-pid=i' => \@include_pid,
'include-session=s' => \@include_session,
'histogram-query=s' => \$histogram_query,
'histogram-session=s' => \$histogram_session,
'no-fork' => \$nofork,
);
die "FATAL: use pgbadger --help\n" if (not $result);
# Force rebuild mode when a month report is asked
$rebuild = 1 if ($month_report);
$rebuild = 2 if ($day_report);
# Set report title
$report_title = &escape_html($report_title) if $report_title;
# Show version and exit if asked
if ($ver) {
print "pgBadger version $VERSION\n";
exit 0;
}
&usage() if ($help);
# Create temporary file directory if not exists
mkdir("$TMP_DIR") if (!-d "$TMP_DIR");
if (!-d "$TMP_DIR")
{
die("Can not use temporary directory $TMP_DIR.\n");
}
# Try to load Digest::MD5 when asked
if ($enable_checksum)
{
if (eval {require Digest::MD5;1} ne 1) {
die("Can not load Perl module Digest::MD5.\n");
} else {
Digest::MD5->import('md5_hex');
}
}
# Check if another process is already running
unless ($PID_FILE) {
$PID_FILE = $PID_DIR . '/pgbadger.pid';
}
if (-e "$PID_FILE")
{
my $is_running = 2;
if ($^O !~ /MSWin32|dos/i) {
eval { $is_running = `ps auwx | grep pgbadger | grep -v grep | wc -l`; chomp($is_running); };
}
if (!$@ && ($is_running <= 1)) {
unlink("$PID_FILE");
} else {
print "FATAL: another process is already started or remove the file, see $PID_FILE\n";
exit 3;
}
}
# Create pid file
if (open(my $out, '>', $PID_FILE))
{
print $out $$;
close($out);
}
else
{
print "FATAL: can't create pid file $PID_FILE, $!\n";
exit 3;
}
# Rewrite some command line arguments as lists
&compute_arg_list();
# If pgBadger must parse remote files set the ssh command
# If no user defined ssh command have been set
my $remote_command = '';
if ($remote_host && !$ssh_command) {
$remote_command = &set_ssh_command($ssh_command, $remote_host);
}
# Add journalctl command to the file list if not already found
if ($journalctl_cmd)
{
if (!grep(/^\Q$journalctl_cmd\E$/, @ARGV))
{
$journalctl_cmd .= " --output='short-iso'";
push(@ARGV, $journalctl_cmd);
}
}
# Add custom command to file list
if ($log_command)
{
if (!grep(/^\Q$log_command\E$/, @ARGV)) {
push(@ARGV, $log_command);
}
}
# Log files to be parsed are passed as command line arguments
my $empty_files = 1;
if ($#ARGV >= 0)
{
if (!$month_report) {
foreach my $file (@ARGV) {
push(@log_files, &set_file_list($file));
}
} elsif (!$outdir) {
$outdir = $ARGV[0];
}
}
if (!$incremental && $html_outdir) {
localdie("FATAL: parameter -H, --html-outdir can only be used with incremental mode.\n");
}
# Read list of log file to parse from a file
if ($logfile_list)
{
if (!-e $logfile_list) {
localdie("FATAL: logfile list $logfile_list must exist!\n");
}
my $in = undef;
if (not open($in, "<", $logfile_list)) {
localdie("FATAL: can not read logfile list $logfile_list, $!.\n");
}
my @files = <$in>;
close($in);
foreach my $file (@files)
{
chomp($file);
$file =~ s/\r//;
if ($file eq '-') {
localdie("FATAL: stdin input - can not be used with logfile list.\n");
}
push(@log_files, &set_file_list($file));
}
}
# Do not warn if all log files are empty
if (!$rebuild && $empty_files)
{
&logmsg('DEBUG', "All log files are empty, exiting...");
unlink("$PID_FILE");
exit 0;
}
# Logfile is a mandatory parameter when journalctl command is not set.
if ( !$rebuild && ($#log_files < 0) && !$journalctl_cmd && !$log_command)
{
if (!$quiet) {
localdie("FATAL: you must give a log file at command line parameter.\n\n", 4);
}
else
{
unlink("$PID_FILE");
exit 4;
}
}
# Check that binary format is not mixed with other formats in multiple output mode
if ($#outfiles >= 1) {
my @has_binary = grep { /\.bin$/i } @outfiles;
if (@has_binary && @outfiles > 1) {
localdie("FATAL: binary format (.bin) cannot be used with multiple output formats.\n\n");
}
if ($dump_normalized_only || $dump_all_queries) {
localdie("FATAL: dump of normalized queries cannot be used with multiple output.\n\n");
}
}
# Remove follow option from journalctl command to prevent infinit loop
if ($journalctl_cmd) {
$journalctl_cmd =~ s/(-f|--follow)\b//;
}
# Quiet mode is forced with progress bar
$progress = 0 if ($quiet || $no_progessbar);
# Set the default number minutes for queries and connections average
$avg_minutes ||= 5;
$avg_minutes = 60 if ($avg_minutes > 60);
$avg_minutes = 1 if ($avg_minutes < 1);
$histo_avg_minutes ||= 60;
$histo_avg_minutes = 60 if ($histo_avg_minutes > 60);
$histo_avg_minutes = 1 if ($histo_avg_minutes < 1);
my @avgs = ();
for (my $i = 0 ; $i < 60 ; $i += $avg_minutes) {
push(@avgs, sprintf("%02d", $i));
}
my @histo_avgs = ();
for (my $i = 0 ; $i < 60 ; $i += $histo_avg_minutes) {
push(@histo_avgs, sprintf("%02d", $i));
}
# Set the URL to submit explain plan
$EXPLAIN_POST = sprintf($EXPLAIN_POST, $EXPLAIN_URL);
# Set error like log level regex
my $parse_regex = qr/^(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|HINT|STATEMENT|CONTEXT|LOCATION)/;
my $full_error_regex = qr/^(WARNING|ERROR|FATAL|PANIC|DETAIL|HINT|STATEMENT|CONTEXT)/;
my $main_error_regex = qr/^(WARNING|ERROR|FATAL|PANIC)/;
my $main_log_regex = qr/^(LOG|WARNING|ERROR|FATAL|PANIC)/;
# Set syslog prefix regex
my $other_syslog_line = '';
my $pgbouncer_log_format = '';
my $pgbouncer_log_parse1 = '';
my $pgbouncer_log_parse2 = '';
my $pgbouncer_log_parse3 = '';
# Variable to store parsed data following the line prefix
my @prefix_params = ();
my @pgb_prefix_params = ();
my @pgb_prefix_parse1 = ();
my @pgb_prefix_parse2 = ();
my @pgb_prefix_parse3 = ();
# Force incremental mode when rebuild mode is used
if ($rebuild && !$incremental) {
print STDERR "WARNING: --rebuild require incremental mode, activating it.\n" if (!$month_report || !$day_report);
$incremental = 1;
}
&logmsg('DEBUG', "pgBadger version $VERSION." );
# set timezone to use
&set_timezone(1);
# Set default top query
$top ||= 20;
# Set output file
my $outfile = '';
$outfile = $outfiles[0] if ($#outfiles >= 0);
if (($dump_normalized_only || $dump_all_queries) && $outfile && $outfile !~ /\.txt$/){
localdie("FATAL: dump of normalized queries can be done in text output format, please use .txt extension.\n\n");
}
# With multiple output format we must use a temporary binary file
my $dft_extens = '';
if ($#outfiles >= 1)
{
# In non-incremental mode, use a temporary binary file.
# In incremental mode, each format will be generated from the binary data.
if (!$incremental)
{
# Set temporary binary file for non-incremental mode.
$outfile = $TMP_DIR . "/pgbadger_tmp_$$.bin";
# Remove the default output format for the moment
# otherwise all dump will have the same output
$dft_extens = $extension;
$extension = '';
}
}
elsif ($#outfiles == -1)
{
$extension = 'txt' if ($dump_normalized_only || $dump_all_queries);
if ($extension) {
push(@outfiles, 'out.' . $extension);
} elsif ($incremental) {
push(@outfiles, 'index.html');
} else {
push(@outfiles, 'out.html');
}
map { s/\.text/.txt/; } @outfiles;
}
# Set the default extension and output format, load JSON Perl module if required
# Force text output with normalized query list only and disable incremental report
# Set default filename of the output file
my ($current_out_file, $extens) = &set_output_extension($outdir, $outfile, $extension);
# Set default syslog ident name
$ident ||= 'postgres';
# Set default pie percentage limit or fix value
$pie_percentage_limit = 0 if ($pie_percentage_limit < 0);
$pie_percentage_limit = 2 if ($pie_percentage_limit eq '');
$pie_percentage_limit = 100 if ($pie_percentage_limit > 100);
# Set default download image format
$img_format = lc($img_format);
$img_format = 'jpeg' if ($img_format eq 'jpg');
$img_format = 'png' if ($img_format ne 'jpeg');
# Extract the output directory from outfile so that graphs will
# be created in the same directory
if ($current_out_file ne '-')
{
if (!$html_outdir && !$outdir)
{
my @infs = fileparse($current_out_file);
if ($infs[0] ne '')
{
$outdir = $infs[1];
}
else
{
# maybe a confusion between -O and -o
localdie("FATAL: output file $current_out_file is a directory, should be a file\nor maybe you want to use -O | --outdir option instead.\n");
}
}
elsif ($outdir && !-d "$outdir")
{
# An output directory has been passed as command line parameter
localdie("FATAL: $outdir is not a directory or doesn't exist.\n");
}
elsif ($html_outdir && !-d "$html_outdir")
{
# An HTML output directory has been passed as command line parameter
localdie("FATAL: $html_outdir is not a directory or doesn't exist.\n");
}
$current_out_file = basename($current_out_file);
$current_out_file = ($html_outdir || $outdir) . '/' . $current_out_file;
$current_out_file =~ s#//#/#g;
}
# Remove graph support if output is not html
$graph = 0 unless ($extens eq 'html' or $extens eq 'binary' or $extens eq 'json');
$graph = 0 if ($nograph);
# Set some default values
my $end_top = $top - 1;
$queue_size ||= 1;
$job_per_file ||= 1;
if ($^O =~ /MSWin32|dos/i)
{
if ( ($queue_size > 1) || ($job_per_file > 1) ) {
print STDERR "WARNING: parallel processing is not supported on this platform.\n";
}
$queue_size = 1;
$job_per_file = 1;
}
# Test file creation before going to parse log
my $tmpfh = new IO::File ">$current_out_file";
if (not defined $tmpfh) {
localdie("FATAL: can't write to $current_out_file, $!\n");
}
$tmpfh->close();
unlink($current_out_file) if (-e $current_out_file);
# -w and --disable-error can't go together
if ($error_only && $disable_error) {
localdie("FATAL: please choose between no event report and reporting events only.\n");
}
# Set default search pattern for database, user name, application name and host in log_line_prefix
my $regex_prefix_dbname = qr/(?:db|database)=([^,]*)/;
my $regex_prefix_dbuser = qr/(?:user|usr)=([^,]*)/;
my $regex_prefix_dbclient = qr/(?:client|remote|ip|host|connection_source)=([^,\(]*)/;
my $regex_prefix_dbappname = qr/(?:app|application|application_name)=([^,]*)/;
my $regex_prefix_queryid = qr/(?:queryid)=([^,]*)/;
my $regex_prefix_sqlstate = qr/(?:error_code|state|state_code)=([^,]*)/;
my $regex_prefix_backendtype = qr/(?:backend_type|btype)=([^,]*)/;
# Set pattern to look for query type
my $action_regex = qr/^[\s\(]*(DELETE|INSERT|UPDATE|SELECT|COPY|WITH|CREATE|DROP|ALTER|TRUNCATE|BEGIN|COMMIT|ROLLBACK|START|END|SAVEPOINT|DECLARE|CLOSE|FETCH|MOVE)/is;
# Loading excluded query from file if any
if ($exclude_file) {
open(my $in, '<', $exclude_file) or localdie("FATAL: can't read file $exclude_file: $!\n");
my @exclq = <$in>;
close($in);
chomp(@exclq);
foreach my $r (@exclq) {
$r =~ s/\r//;
&check_regex($r, '--exclude-file');
}
push(@exclude_query, @exclq);
}
# Testing regex syntax
if ($#exclude_query >= 0) {
foreach my $r (@exclude_query) {
&check_regex($r, '--exclude-query');
}
}
# Testing regex syntax
if ($#exclude_time >= 0) {
foreach my $r (@exclude_time) {
&check_regex($r, '--exclude-time');
}
}
#
# Testing regex syntax
if ($#include_time >= 0) {
foreach my $r (@include_time) {
&check_regex($r, '--include-time');
}
}
# Loading included query from file if any
if ($include_file) {
open(my $in, '<', $include_file) or localdie("FATAL: can't read file $include_file: $!\n");
my @exclq = <$in>;
close($in);
chomp(@exclq);
foreach my $r (@exclq) {
$r =~ s/\r//;
&check_regex($r, '--include-file');
}
push(@include_query, @exclq);
}
# Testing regex syntax
if ($#include_query >= 0) {
foreach my $r (@include_query) {
&check_regex($r, '--include-query');
}
}
# Check start/end date time
if ($from)
{
if ( $from =~ /^(\d{2}):(\d{2}):(\d{2})([.]\d+([+-]\d+)?)?$/)
{
# only time, trick around the date part
my $fractional_seconds = $4 || "0";
$from_hour = "$1:$2:$3.$fractional_seconds";
&logmsg('DEBUG', "Setting begin time to [$from_hour]" );
}
elsif( $from =~ /^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})([.]\d+([+-]\d+)?)?$/ )
{
my $fractional_seconds = $7 || "0";
$from = "$1-$2-$3 $4:$5:$6.$fractional_seconds";
&logmsg('DEBUG', "Setting begin datetime to [$from]" );
}
else
{
localdie("FATAL: bad format for begin datetime/time, should be yyyy-mm-dd hh:mm:ss.l+tz or hh:mm:ss.l+tz\n");
}
}
if ($to)
{
if ( $to =~ /^(\d{2}):(\d{2}):(\d{2})([.]\d+([+-]\d+)?)?$/)
{
# only time, trick around the date part
my $fractional_seconds = $4 || "0";
$to_hour = "$1:$2:$3.$fractional_seconds";
&logmsg('DEBUG', "Setting end time to [$to_hour]" );
}
elsif( $to =~ /^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})([.]\d+([+-]\d+)?)?$/)
{
my $fractional_seconds = $7 || "0";
$to = "$1-$2-$3 $4:$5:$6.$fractional_seconds";
&logmsg('DEBUG', "Setting end time to [$to]" );
}
else
{
localdie("FATAL: bad format for ending datetime, should be yyyy-mm-dd hh:mm:ss.l+tz or hh:mm:ss.l+tz\n");
}
}
if ($from && $to && ($from gt $to)) {
localdie("FATAL: begin date is after end date!\n") ;
}
# Stores the last parsed line from log file to allow incremental parsing
my $LAST_LINE = '';
# Set the level of the data aggregator, can be minute, hour or day follow the
# size of the log file.
my $LEVEL = 'hour';
# Month names
my %month_abbr = (
'Jan' => '01', 'Feb' => '02', 'Mar' => '03', 'Apr' => '04', 'May' => '05', 'Jun' => '06',
'Jul' => '07', 'Aug' => '08', 'Sep' => '09', 'Oct' => '10', 'Nov' => '11', 'Dec' => '12'
);
my %abbr_month = (
'01' => 'Jan', '02' => 'Feb', '03' => 'Mar', '04' => 'Apr', '05' => 'May', '06' => 'Jun',
'07' => 'Jul', '08' => 'Aug', '09' => 'Sep', '10' => 'Oct', '11' => 'Nov', '12' => 'Dec'
);
# Inbounds of query times histogram
my @histogram_query_time = (0, 1, 5, 10, 25, 50, 100, 500, 1000, 10000);
# Inbounds of session times histogram
my @histogram_session_time = (0, 500, 1000, 30000, 60000, 600000, 1800000, 3600000, 28800000);
# Check histogram values user redefinition
if ($histogram_query)
{
if ($histogram_query =~ /[^0-9\s,]+/) {
die("Incorrect value for option --histogram_query\n");
}
@histogram_query_time = split(/\s*,\s*/, $histogram_query);
}
if ($histogram_session)
{
if ($histogram_session =~ /[^0-9\s,]+/) {
die("Incorrect value for option --histogram_session\n");
}
@histogram_session_time = split(/\s*,\s*/, $histogram_session);
}
# Where statistics are stored
my %overall_stat = ();
my %pgb_overall_stat = ();
my %overall_checkpoint = ();
my %top_slowest = ();
my %normalyzed_info = ();
my %error_info = ();
my %pgb_error_info = ();
my %pgb_pool_info = ();
my %logs_type = ();
my %errors_code = ();
my %per_minute_info = ();
my %pgb_per_minute_info = ();
my %lock_info = ();
my %tempfile_info = ();
my %cancelled_info = ();
my %connection_info = ();
my %pgb_connection_info = ();
my %database_info = ();
my %application_info = ();
my %user_info = ();
my %host_info = ();
my %session_info = ();
my %pgb_session_info = ();
my %conn_received = ();
my %checkpoint_info = ();
my %autovacuum_info = ();
my %autoanalyze_info = ();
my @graph_values = ();
my %cur_info = ();
my %cur_temp_info = ();
my %cur_plan_info = ();
my %cur_cancel_info = ();
my %cur_lock_info = ();
my $nlines = 0;
my %last_line = ();
my %pgb_last_line = ();
our %saved_last_line = ();
our %pgb_saved_last_line= ();
my %top_locked_info = ();
my %top_tempfile_info = ();
my %top_cancelled_info = ();
my %drawn_graphs = ();
my %cur_bind_info = ();
my %prepare_info = ();
my %bind_info = ();
# Global output filehandle
my $fh = undef;
my $t0 = Benchmark->new;
# Write resources files from __DATA__ section if they have not been already copied
# and return the HTML links to that files. If --extra-file is not used returns the
# CSS and JS code to be embeded in HTML files
my @jscode = &write_resources();
# Automatically set parameters with incremental mode
if ($incremental)
{
# In incremental mode an output directory must be set
if (!$html_outdir && !$outdir)
{
localdie("FATAL: you must specify an output directory with incremental mode, see -O or --outdir.\n")
}
# Ensure this is not a relative path
if ($outdir && dirname($outdir) eq '.')
{
localdie("FATAL3: output directory ($outdir) is not an absolute path.\n");
}
if ($html_outdir && dirname($html_outdir) eq '.')
{
localdie("FATAL: output HTML directory ($html_outdir) is not an absolute path.\n");
}
# Ensure that the directory already exists
if ($outdir && !-d $outdir)
{
localdie("FATAL: output directory $outdir does not exists.\n");
}
# Verify that the HTML outdir exixts when specified
if ($html_outdir && !-d $html_outdir)
{
localdie("FATAL: output HTML directory $html_outdir does not exists.\n");
}
# Set default last parsed file in incremental mode
if (!$last_parsed && $incremental)
{
$last_parsed = $outdir . '/LAST_PARSED';
}
$current_out_file = 'index.html';
# Set default output format
$extens = 'binary';
if ($rebuild && !$month_report && !$day_report)
{
# Look for directory where report must be generated again
my @build_directories = ();
# Find directories that shoud be rebuilt
unless(opendir(DIR, "$outdir"))
{
localdie("FATAL: can't opendir $outdir: $!\n");
}
my @dyears = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
foreach my $y (sort { $a <=> $b } @dyears)
{
unless(opendir(DIR, "$outdir/$y"))
{
localdie("FATAL: can't opendir $outdir/$y: $!\n");
}
my @dmonths = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
foreach my $m (sort { $a <=> $b } @dmonths)
{
unless(opendir(DIR, "$outdir/$y/$m"))
{
localdie("FATAL: can't opendir $outdir/$y/$m: $!\n");
}
my @ddays = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
foreach my $d (sort { $a <=> $b } @ddays)
{
unless(opendir(DIR, "$outdir/$y/$m/$d"))
{
localdie("FATAL: can't opendir $outdir/$y/$m/$d: $!\n");
}
my @binfiles = grep { $_ =~ /\.bin$/ } readdir(DIR);
closedir DIR;
push(@build_directories, "$y-$m-$d") if ($#binfiles >= 0);
}
}
}
&build_incremental_reports(@build_directories);
my $t2 = Benchmark->new;
my $td = timediff($t2, $t0);
&logmsg('DEBUG', "rebuilding reports took: " . timestr($td));
# Remove pidfile
unlink("$PID_FILE");
exit 0;
}
elsif ($month_report)
{
# Look for directory where cumulative report must be generated
my @build_directories = ();
# Get year+month as a path
$month_report =~ s#/#-#g;
my $month_path = $month_report;
$month_path =~ s#-#/#g;
if ($month_path !~ m#^\d{4}/\d{2}$#)
{
localdie("FATAL: invalid format YYYY-MM for --month-report option: $month_report");
}
&logmsg('DEBUG', "building month report into $outdir/$month_path");
# Find days directories that shoud be used to build the monthly report
unless(opendir(DIR, "$outdir/$month_path"))
{
localdie("FATAL: can't opendir $outdir/$month_path: $!\n");
}
my @ddays = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
foreach my $d (sort { $a <=> $b } @ddays)
{
unless(opendir(DIR, "$outdir/$month_path/$d"))
{
localdie("FATAL: can't opendir $outdir/$month_path/$d: $!\n");
}
my @binfiles = grep { $_ =~ /\.bin$/ } readdir(DIR);
closedir DIR;
push(@build_directories, "$month_report-$d") if ($#binfiles >= 0);
}
&build_month_reports($month_path, @build_directories);
my $t2 = Benchmark->new;
my $td = timediff($t2, $t0);
&logmsg('DEBUG', "building month report took: " . timestr($td));
# Remove pidfile
unlink("$PID_FILE");
exit 0;
}
elsif ($day_report)
{
# Look for directory where cumulative report must be generated
my @build_directories = ();
# Get year+month as a path
$day_report =~ s#/#-#g;
my $day_path = $day_report;
$day_path =~ s#-#/#g;
if ($day_path !~ m#^\d{4}/\d{2}\/\d{2}$#)
{
localdie("FATAL: invalid format YYYY-MM-DD for --day-report option: $day_report");
}
&logmsg('DEBUG', "building day report into $outdir/$day_path");
# Find days directories that shoud be used to build the monthly report
unless(opendir(DIR, "$outdir/$day_path"))
{
localdie("FATAL: can't opendir $outdir/$day_path: $!\n");
}
my @binfiles = grep { $_ =~ /\.bin$/ } readdir(DIR);
closedir DIR;
push(@build_directories, "$day_report") if ($#binfiles >= 0);
&build_day_reports($day_path, @build_directories);
my $t2 = Benchmark->new;
my $td = timediff($t2, $t0);
&logmsg('DEBUG', "building day report took: " . timestr($td));
# Remove pidfile
unlink("$PID_FILE");
exit 0;
}
}
else
{
# Extra files for resources are not allowed without incremental mode
$extra_files = 0;
}
# Reading last line parsed
if ($last_parsed && -e $last_parsed)
{
if (open(my $in, '<', $last_parsed))
{
my @content = <$in>;
close($in);
foreach my $line (@content)
{
chomp($line);
next if (!$line);
my ($datetime, $current_pos, $orig, @others) = split(/\t/, $line);
# Last parsed line with pgbouncer log starts with this keyword
if ($datetime eq 'pgbouncer')
{
$pgb_saved_last_line{datetime} = $current_pos;
$pgb_saved_last_line{current_pos} = $orig;
$pgb_saved_last_line{orig} = join("\t", @others);
}
else
{
$saved_last_line{datetime} = $datetime;
$saved_last_line{current_pos} = $current_pos;
$saved_last_line{orig} = $orig;
}
&logmsg('DEBUG', "Found log offset " . ($saved_last_line{current_pos} || $pgb_saved_last_line{current_pos}) . " in file $last_parsed");
}
# Those two log format must be read from start of the file
if ( ($format eq 'binary') || ($format eq 'csv') )
{
$saved_last_line{current_pos} = 0;
$pgb_saved_last_line{current_pos} = 0 if ($format eq 'binary');
}
}
else
{
localdie("FATAL: can't read last parsed line from $last_parsed, $!\n");
}
}
$tmp_last_parsed = 'tmp_' . basename($last_parsed) if ($last_parsed);
$tmp_last_parsed = "$TMP_DIR/$tmp_last_parsed";
$tmp_dblist = "$TMP_DIR/dblist.tmp";
###
### Explanation:
###
### Logic for the BINARY storage ($outdir) SHOULD be:
### If ('noclean')
### do nothing (keep everything)
### If (NO 'noclean') and (NO 'retention'):
### use an arbitrary retention duration of: 5 weeks
### remove BINARY files older than LAST_PARSED_MONTH-retention
### DO NOT CHECK for HTML file existence as OLD HTML files may be deleted by external tools
### which may lead to BINARY files NEVER deleted
### If (NO 'noclean') and ('retention'):
### remove BINARY files older than LAST_PARSED_MONTH-retention
### DO NOT CHECK for HTML file existence as OLD HTML files may be deleted by external tools
### which may lead to BINARY files NEVER deleted
###
### Logic for the HTML storage ($html_outdir || $outdir) SHOULD be:
### DO NOT check 'noclean' as this flag is dedicated to BINARY files
### If (NO 'retention'):
### do nothing (keep everything)
### If ('retention'):
### remove HTML folders/files older than LAST_PARSED_MONTH-retention (= y/m/d):
### days older than d in y/m/d
### months older than m in y/m/d
### years older than y in y/m/d
###
# Clear BIN/HTML storages in incremental mode
my @all_outdir = ();
push(@all_outdir, $outdir) if ($outdir);
push(@all_outdir, $html_outdir) if ($html_outdir);
### $retention_bin = 5 if (!$noclean && !$retention);
### $retention_bin = 0 if ($noclean && !$retention);
### $retention_bin = $retention if (!$noclean && $retention);
### $retention_bin = 0 if ($noclean && $retention);
### equivalent to:
my $retention_bin = $retention;
$retention_bin = 0 if ($noclean && $retention);
$retention_bin = 5 if (!$noclean && !$retention);
### $retention_html = 0 if (!$noclean && !$retention);
### $retention_html = 0 if ($noclean && !$retention);
### $retention_html = $retention if (!$noclean && $retention);
### $retention_html = $retention if ($noclean && $retention);
### equivalent to:
my $retention_html = $retention;
### We will handle noclean/!noclean and retention_xxx/!retention_xxx below
### Note: !retention_xxx equivalent to retention_xxx = 0
&logmsg('DEBUG', "BIN/HTML Retention cleanup: Initial cleanup flags - noclean=[$noclean] - retention_bin=[$retention_bin] - retention_html=[$retention_html] - saved_last_line{datetime}=[$saved_last_line{datetime}] - pgb_saved_last_line{datetime}=[$pgb_saved_last_line{datetime}] - all_outdir=[@all_outdir]");
if ( scalar(@all_outdir) && ($saved_last_line{datetime} || $pgb_saved_last_line{datetime}) )
{
foreach my $ret_dir (@all_outdir)
{
if (($saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /) ||
($pgb_saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /))
{
# Search the current week following the last parse date
my $limit_yw_bin = $1;
my $limit_yw_html = $1;
my $wn = &get_week_number($1, $2, $3);
# BIN: Case of year overlap
if (($wn - $retention_bin) < 1)
{
# Rewind to previous year
$limit_yw_bin--;
# Get number of last week of previous year, can be 52 or 53
my $prevwn = &get_week_number($limit_yw_bin, 12, 31);
# Add week number including retention_bin to the previous year
$limit_yw_bin .= sprintf("%02d", $prevwn - abs($wn - $retention_bin));
} else {
$limit_yw_bin .= sprintf("%02d", $wn - $retention_bin);
}
&logmsg('DEBUG', "BIN Retention cleanup: YearWeek Limit computation - YearWeek=<$limit_yw_bin> - This will help later removal");
# HTML: Case of year overlap
if (($wn - $retention_html) < 1)
{
# Rewind to previous year
$limit_yw_html--;
# Get number of last week of previous year, can be 52 or 53
my $prevwn = &get_week_number($limit_yw_html, 12, 31);
# Add week number including retention_html to the previous year
$limit_yw_html .= sprintf("%02d", $prevwn - abs($wn - $retention_html));
} else {
$limit_yw_html .= sprintf("%02d", $wn - $retention_html);
}
&logmsg('DEBUG', "HTML Retention cleanup: YearWeek Limit computation - YearWeek=<$limit_yw_html> - This will help later removal");
my @dyears = ();
if ( opendir(DIR, "$ret_dir") ) {
@dyears = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
} else {
&logmsg('ERROR', "BIN/HTML Retention cleanup: can't opendir $ret_dir: $!");
}
# Find obsolete weeks dir that shoud be cleaned
foreach my $y (sort { $a <=> $b } @dyears) {
my @weeks = ();
if ( opendir(DIR, "$ret_dir/$y") ) {
@weeks = grep { $_ =~ /^week-\d+$/ } readdir(DIR);
closedir DIR;
} else {
&logmsg('ERROR', "BIN/HTML Retention cleanup: can't opendir $ret_dir/$y: $!");
}
foreach my $w (sort { $a <=> $b } @weeks) {
$w =~ /^week-(\d+)$/;
if ( (!$noclean) && $retention_bin ) {
if ("$y$1" lt $limit_yw_bin) {
&logmsg('DEBUG', "BIN Retention cleanup: Removing obsolete week directory $ret_dir/$y/week-$1");
&cleanup_directory_bin("$ret_dir/$y/week-$1", 1);
}
}
if ( $retention_html ) {
if ("$y$1" lt $limit_yw_html) {
&logmsg('DEBUG', "HTML Retention cleanup: Removing obsolete week directory $ret_dir/$y/week-$1");
&cleanup_directory_html("$ret_dir/$y/week-$1", 1);
}
}
}
}
# Find obsolete months and days
foreach my $y (sort { $a <=> $b } @dyears) {
my @dmonths = ();
if ( opendir(DIR, "$ret_dir/$y") ) {
@dmonths = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
} else {
&logmsg('ERROR', "BIN/HTML Retention cleanup: can't opendir $ret_dir/$y: $!");
}
# Now remove the HTML monthly reports
if ( $retention_html ) {
foreach my $m (sort { $a <=> $b } @dmonths) {
my $diff_day = $retention_html * 7 * 86400;
my $lastday = 0;
if (($saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /) ||
($pgb_saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /)) {
$lastday = timelocal(1,1,1,$3,$2-1,$1-1900);
}
if ( $lastday ) {
my $lastday_minus_retention = $lastday - $diff_day;
my $lastday_minus_retention_Y = strftime('%Y', localtime($lastday_minus_retention));
my $lastday_minus_retention_M = strftime('%m', localtime($lastday_minus_retention));
my $lastday_minus_retention_prev_month_Y = $lastday_minus_retention_Y;
my $lastday_minus_retention_prev_month_M = $lastday_minus_retention_M - 1;
if ( $lastday_minus_retention_prev_month_M < 1 ) {
$lastday_minus_retention_prev_month_Y -= 1;
$lastday_minus_retention_prev_month_M = 12;
}
$lastday_minus_retention_prev_month_Y = sprintf("%04d", $lastday_minus_retention_prev_month_Y);
$lastday_minus_retention_prev_month_M = sprintf("%02d", $lastday_minus_retention_prev_month_M);
if ("$y$m" lt "$lastday_minus_retention_Y$lastday_minus_retention_M") {
&logmsg('DEBUG', "HTML Retention cleanup: Removing obsolete month directory $ret_dir/$y/$m");
&cleanup_directory_html("$ret_dir/$y/$m", 1);
}
}
}
}
# Now remove the corresponding days
foreach my $m (sort { $a <=> $b } @dmonths) {
my @ddays = ();
if ( opendir(DIR, "$ret_dir/$y/$m") ) {
@ddays = grep { $_ =~ /^\d+$/ } readdir(DIR);
closedir DIR;
} else {
&logmsg('ERROR', "BIN/HTML Retention cleanup: can't opendir $ret_dir/$y/$m: $!");
}
foreach my $d (sort { $a <=> $b } @ddays)
{
if ( (!$noclean) && $retention_bin ) {
# Remove obsolete days when we are in binary mode
# with noreport - there's no week-N directory
my $diff_day = $retention_bin * 7 * 86400;
my $oldday = timelocal(1,1,1,$d,$m-1,$y-1900);
my $lastday = $oldday;
if (($saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /) ||
($pgb_saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /)) {
$lastday = timelocal(1,1,1,$3,$2-1,$1-1900);
}
if (($lastday - $oldday) > $diff_day) {
&logmsg('DEBUG', "BIN Retention cleanup: Removing obsolete day directory $ret_dir/$y/$m/$d");
&cleanup_directory_bin("$ret_dir/$y/$m/$d", 1);
}
}
if ( $retention_html ) {
# Remove obsolete days when we are in binary mode
# with noreport - there's no week-N directory
my $diff_day = $retention_html * 7 * 86400;
my $oldday = timelocal(1,1,1,$d,$m-1,$y-1900);
my $lastday = $oldday;
if (($saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /) ||
($pgb_saved_last_line{datetime} =~ /^(\d+)\-(\d+)\-(\d+) /)) {
$lastday = timelocal(1,1,1,$3,$2-1,$1-1900);
}
if (($lastday - $oldday) > $diff_day) {
&logmsg('DEBUG', "HTML Retention cleanup: Removing obsolete day directory $ret_dir/$y/$m/$d");
&cleanup_directory_html("$ret_dir/$y/$m/$d", 1);
}
}
}
if ( rmdir("$ret_dir/$y/$m") ) {
&logmsg('DEBUG', "BIN/HTML Retention cleanup: Removing obsolete empty directory $ret_dir/$y/$m");
}
}
if ( rmdir("$ret_dir/$y") ) {
&logmsg('DEBUG', "BIN/HTML Retention cleanup: Removing obsolete empty directory $ret_dir/$y");
}
}
}
}
}
# Main loop reading log files
my $global_totalsize = 0;
my @given_log_files = ( @log_files );
chomp(@given_log_files);
# Store globaly total size for each log files
my %file_size = ();
foreach my $logfile ( @given_log_files )
{
$file_size{$logfile} = &get_file_size($logfile);
$global_totalsize += $file_size{$logfile} if ($file_size{$logfile} > 0);
}
# Verify that the file has not changed for incremental move
if (($incremental || $last_parsed) && !$remote_host)
{
my @tmpfilelist = ();
# Removed files that have already been parsed during previous runs
foreach my $f (@given_log_files)
{
if ($f eq '-')
{
&logmsg('DEBUG', "waiting for log entries from stdin.");
$saved_last_line{current_pos} = 0;
push(@tmpfilelist, $f);
}
elsif ($f =~ /\.bin$/)
{
&logmsg('DEBUG', "binary file \"$f\" as input, there is no log to parse.");
$saved_last_line{current_pos} = 0;
push(@tmpfilelist, $f);
}
elsif ( $journalctl_cmd && ($f eq $journalctl_cmd) )
{
my $since = '';
if ( ($journalctl_cmd !~ /--since|-S/) &&
($saved_last_line{datetime} =~ /^(\d+)-(\d+)-(\d+).(\d+):(\d+):(\d+)/) )
{
$since = " --since='$1-$2-$3 $4:$5:$6'";
}
&logmsg('DEBUG', "journalctl call will start since: $saved_last_line{datetime}");
my $new_journalctl_cmd = "$f$since";
push(@tmpfilelist, $new_journalctl_cmd);
$file_size{$new_journalctl_cmd} = $file_size{$f};
}
elsif ( $log_command && ($f eq $log_command) )
{
&logmsg('DEBUG', "custom command waiting for log entries from stdin.");
$saved_last_line{current_pos} = 0;
push(@tmpfilelist, $f);
}
else
{
# Auto detect log format for proper parsing
my $fmt = $format || 'stderr';
$fmt = autodetect_format($f, $file_size{$f});
$fmt ||= $format;
# Set regex to parse the log file
$fmt = set_parser_regex($fmt);
if (($fmt ne 'pgbouncer') && ($saved_last_line{current_pos} > 0))
{
my ($retcode, $msg) = &check_file_changed($f, $file_size{$f}, $fmt, $saved_last_line{datetime}, $saved_last_line{current_pos});
if (!$retcode)
{
&logmsg('DEBUG', "this file has already been parsed: $f, $msg");
}
else
{
push(@tmpfilelist, $f);
}
}
elsif (($fmt eq 'pgbouncer') && ($pgb_saved_last_line{current_pos} > 0))
{
my ($retcode, $msg) = &check_file_changed($f, $file_size{$f}, $fmt, $pgb_saved_last_line{datetime}, $pgb_saved_last_line{current_pos});
if (!$retcode)
{
&logmsg('DEBUG', "this file has already been parsed: $f, $msg");
}
else
{
push(@tmpfilelist, $f);
}
}
else
{
push(@tmpfilelist, $f);
}
}
}
@given_log_files = ();
push(@given_log_files, @tmpfilelist);
}
# Pipe used for progress bar in multiprocess
my $pipe = undef;
# Seeking to an old log position is not possible outside incremental mode
if (!$last_parsed || !exists $saved_last_line{current_pos}) {
$saved_last_line{current_pos} = 0;
$pgb_saved_last_line{current_pos} = 0;
}
if ($dump_all_queries)
{
$fh = new IO::File;
$fh->open($outfiles[0], '>') or localdie("FATAL: can't open output file $outfiles[0], $!\n");
}
####
# Start parsing all log files
####
# Number of running process
my $child_count = 0;
# Set max number of parallel process
my $parallel_process = 0;
# Open a pipe for interprocess communication
my $reader = new IO::Handle;
my $writer = new IO::Handle;
# Fork the logger process
if (!$nofork && $progress)
{
$pipe = IO::Pipe->new($reader, $writer);
$writer->autoflush(1);
spawn sub
{
&multiprocess_progressbar($global_totalsize);
};
}
# Initialise the list of reports to produce with the default report
# if $report_per_database is enabled there will be a report for each
# database. Information not related to a database (checkpoint, pgbouncer
# statistics, etc.) will be included in the default report which should
# be the postgres database to be read by the DBA of the PostgreSQL cluster.
$DBLIST{$DBALL} = 1;
# Prevent parallelism perl file to be higher than the number of files
$job_per_file = ($#given_log_files+1) if ( ($job_per_file > 1) && ($job_per_file > ($#given_log_files+1)) );
# Parse each log file following the multiprocess mode chosen (-j or -J)
my $current_log_file = '';
foreach my $logfile ( @given_log_files )
{
$current_log_file = $logfile if ($#given_log_files > 0);
# If we just want to build incremental reports from binary files
# just build the list of input directories with binary files
if ($incremental && $html_outdir && !$outdir)
{
my $incr_date = '';
my $binpath = '';
if ($logfile =~ /^(.*\/)(\d+)\/(\d+)\/(\d+)\/[^\/]+\.bin$/)
{
$binpath = $1;
$incr_date = "$2-$3-$4";
}
# Mark the directory as needing index update
if (open(my $out, '>>', "$last_parsed.tmp")) {
print $out "$binpath$incr_date\n";
close($out);
} else {
&logmsg('ERROR', "can't save last parsed line into $last_parsed.tmp, $!");
}
next;
}
# Confirm if we can use multiprocess for this file
my $pstatus = confirm_multiprocess($logfile);
if ($pstatus >= 0)
{
if ($pstatus = 1 && $job_per_file > 1)
{
$parallel_process = $job_per_file;
}
else
{
$parallel_process = $queue_size;
}
}
else
{
&logmsg('DEBUG', "parallel processing will not be used.");
$parallel_process = 1;
}
# Wait until a child dies if max parallel processes is reach
while ($child_count >= $parallel_process)
{
my $kid = waitpid(-1, WNOHANG);
if ($kid > 0)
{
$child_count--;
delete $RUNNING_PIDS{$kid};
}
sleep(1);
}
# Get log format of the current file
my $fmt = $format || 'stderr';
my $logfile_orig = $logfile;
if ($logfile ne '-' && !$journalctl_cmd && !$log_command)
{
$fmt = &autodetect_format($logfile, $file_size{$logfile});
$fmt ||= $format;
# Remove log format from filename if any
$logfile =~ s/:(stderr|csv|syslog|pgbouncer|jsonlog|logplex|rds|redshift)\d*$//i;
&logmsg('DEBUG', "pgBadger will use log format $fmt to parse $logfile.");
}
else
{
&logmsg('DEBUG', "Can not autodetect log format, assuming $fmt.");
}
# Set the timezone to use
&set_timezone();
# Set the regex to parse the log file following the format
$fmt = set_parser_regex($fmt);
# Do not use split method with remote and compressed files, stdin, custom or journalctl command
if ( ($parallel_process > 1) && ($queue_size > 1) &&
($logfile !~ $compress_extensions) &&
($logfile !~ /\.bin$/i) && ($logfile ne '-') &&
($logfile !~ /^(http[s]*|ftp[s]*|ssh):/i) &&
(!$journalctl_cmd || ($logfile !~ /\Q$journalctl_cmd\E/)) &&
(!$log_command || ($logfile !~ /\Q$log_command\E/))
)
{
# Create multiple processes to parse one log file by chunks of data
my @chunks = split_logfile($logfile, $file_size{$logfile_orig}, ($fmt eq 'pgbouncer') ? $pgb_saved_last_line{current_pos} : $saved_last_line{current_pos});
&logmsg('DEBUG', "The following boundaries will be used to parse file $logfile, " . join('|', @chunks));
for (my $i = 0; $i < $#chunks; $i++)
{
while ($child_count >= $parallel_process)
{
my $kid = waitpid(-1, WNOHANG);
if ($kid > 0)
{
$child_count--;
delete $RUNNING_PIDS{$kid};
}
sleep(1);
}
localdie("FATAL: Abort signal received when processing to next chunk\n") if ($interrupt == 2);
last if ($interrupt);
push(@tempfiles, [ tempfile('tmp_pgbadgerXXXX', SUFFIX => '.bin', DIR => $TMP_DIR, O_TEMPORARY => 1, UNLINK => 1 ) ]);
spawn sub
{
&process_file($logfile, $file_size{$logfile_orig}, $fmt, $tempfiles[-1]->[0], $chunks[$i], $chunks[$i+1], $i);
};
$child_count++;
}
}
else
{
# Start parsing one file per parallel process
if (!$nofork)
{
push(@tempfiles, [ tempfile('tmp_pgbadgerXXXX', SUFFIX => '.bin', DIR => $TMP_DIR, UNLINK => 1 ) ]);
spawn sub
{
&process_file($logfile, $file_size{$logfile_orig}, $fmt, $tempfiles[-1]->[0], ($fmt eq 'pgbouncer') ? $pgb_saved_last_line{current_pos} : $saved_last_line{current_pos});
};
$child_count++;
}
else
{
&process_file($logfile, $file_size{$logfile_orig}, $fmt, undef, ($fmt eq 'pgbouncer') ? $pgb_saved_last_line{current_pos} : $saved_last_line{current_pos});
}
}
localdie("FATAL: Abort signal received when processing next file\n") if ($interrupt == 2);
last if ($interrupt);
}
# Wait for all child processes to localdie except for the logger
# On Windows OS $progress is disabled so we don't go here
while (scalar keys %RUNNING_PIDS > $progress)
{
my $kid = waitpid(-1, WNOHANG);
if ($kid > 0) {
delete $RUNNING_PIDS{$kid};
}
sleep(1);
}
# Terminate the process logger
if (!$nofork)
{
foreach my $k (keys %RUNNING_PIDS)
{
kill('USR1', $k);
%RUNNING_PIDS = ();
}
# Clear previous statistics
&init_stats_vars();
}
# Load all data gathered by all the different processes
if (!$nofork)
{
foreach my $f (@tempfiles)
{
next if (!-e "$f->[1]" || -z "$f->[1]");
my $fht = new IO::File;
$fht->open("< $f->[1]") or localdie("FATAL: can't open temp file $f->[1], $!\n");
load_stats($fht);
$fht->close();
}
}
# Get last line parsed from all process
if ($last_parsed)
{
&logmsg('DEBUG', "Reading temporary last parsed line from $tmp_last_parsed");
if (open(my $in, '<', $tmp_last_parsed) )
{
while (my $line = <$in>)
{
chomp($line);
$line =~ s/\r//;
my ($d, $p, $l, @o) = split(/\t/, $line);
if ($d ne 'pgbouncer')
{
if (!$last_line{datetime} || ($d gt $last_line{datetime}))
{
$last_line{datetime} = $d;
$last_line{orig} = $l;
$last_line{current_pos} = $p;
}
}
else
{
$d = $p;
$p = $l;
$l = join("\t", @o);
if (!$pgb_last_line{datetime} || ($d gt $pgb_last_line{datetime}))
{
$pgb_last_line{datetime} = $d;
$pgb_last_line{orig} = $l;
$pgb_last_line{current_pos} = $p;
}
}
}
close($in);
}
unlink("$tmp_last_parsed");
}
# Save last line parsed
if ($last_parsed && ($last_line{datetime} || $pgb_last_line{datetime})
&& ($last_line{orig} || $pgb_last_line{orig}) )
{
&logmsg('DEBUG', "Saving last parsed line into $last_parsed");
if (open(my $out, '>', $last_parsed))
{
if ($last_line{datetime})
{
$last_line{current_pos} ||= 0;
print $out "$last_line{datetime}\t$last_line{current_pos}\t$last_line{orig}\n";
}
elsif ($saved_last_line{datetime})
{
$saved_last_line{current_pos} ||= 0;
print $out "$saved_last_line{datetime}\t$saved_last_line{current_pos}\t$saved_last_line{orig}\n";
}
if ($pgb_last_line{datetime})
{
$pgb_last_line{current_pos} ||= 0;
print $out "pgbouncer\t$pgb_last_line{datetime}\t$pgb_last_line{current_pos}\t$pgb_last_line{orig}\n";
}
elsif ($pgb_saved_last_line{datetime})
{
$pgb_saved_last_line{current_pos} ||= 0;
print $out "pgbouncer\t$pgb_saved_last_line{datetime}\t$pgb_saved_last_line{current_pos}\t$pgb_saved_last_line{orig}\n";
}
close($out);
}
else
{
&logmsg('ERROR', "can't save last parsed line into $last_parsed, $!");
}
}
if ($terminate)
{
unlink("$PID_FILE");
exit 2;
}
####
# Generates statistics output
####
my $t1 = Benchmark->new;
my $td = timediff($t1, $t0);
&logmsg('DEBUG', "the log statistics gathering took:" . timestr($td));
if ($dump_all_queries)
{
$fh->close();
# Remove pidfile and temporary file
unlink($tmp_dblist) if ($tmp_dblist);
unlink("$PID_FILE");
unlink("$last_parsed.tmp") if (-e "$last_parsed.tmp");
unlink($TMP_DIR . "/pgbadger_tmp_$$.bin") if ($#outfiles >= 1);
exit 0;
}
# Read the list of database we have proceeded in all child process
if ($report_per_database)
{
%DBLIST = ();
if (open(my $out, '<', "$tmp_dblist"))
{
my @data = <$out>;
foreach my $tmp (@data)
{
chomp($tmp);
my %dblist = split(/;/, $tmp);
foreach my $d (keys %dblist)
{
next if ($#dbname >= 0 and !grep(/^$d$/i, @dbname));
$DBLIST{$d} = 1;
$overall_stat{nlines}{$d} += $dblist{$d};
}
}
close($out);
&logmsg('DEBUG', "looking for list of database retrieved from log: " . join(',', keys %DBLIST));
}
else
{
&logmsg('ERROR', "can't read list of database from file $tmp_dblist, $!");
}
}
if ( !$incremental && ($#given_log_files >= 0) )
{
# If we have a temporary binary file (multiple output formats), load it before generating reports
if ($#outfiles >= 1 && -e $TMP_DIR . "/pgbadger_tmp_$$.bin")
{
&init_stats_vars();
if (open(my $bin_fh, '<', $TMP_DIR . "/pgbadger_tmp_$$.bin"))
{
my %stats = %{ fd_retrieve($bin_fh) };
close($bin_fh);
# Restore all statistics from binary file
%overall_stat = %{ $stats{overall_stat} } if (exists $stats{overall_stat});
%pgb_overall_stat = %{ $stats{pgb_overall_stat} } if (exists $stats{pgb_overall_stat});
%overall_checkpoint = %{ $stats{overall_checkpoint} } if (exists $stats{overall_checkpoint});
%normalyzed_info = %{ $stats{normalyzed_info} } if (exists $stats{normalyzed_info});
%error_info = %{ $stats{error_info} } if (exists $stats{error_info});
%pgb_error_info = %{ $stats{pgb_error_info} } if (exists $stats{pgb_error_info});
%pgb_pool_info = %{ $stats{pgb_pool_info} } if (exists $stats{pgb_pool_info});
%connection_info = %{ $stats{connection_info} } if (exists $stats{connection_info});
%pgb_connection_info = %{ $stats{pgb_connection_info} } if (exists $stats{pgb_connection_info});
%database_info = %{ $stats{database_info} } if (exists $stats{database_info});
%application_info = %{ $stats{application_info} } if (exists $stats{application_info});
%user_info = %{ $stats{user_info} } if (exists $stats{user_info});
%host_info = %{ $stats{host_info} } if (exists $stats{host_info});
%checkpoint_info = %{ $stats{checkpoint_info} } if (exists $stats{checkpoint_info});
%session_info = %{ $stats{session_info} } if (exists $stats{session_info});
%pgb_session_info = %{ $stats{pgb_session_info} } if (exists $stats{pgb_session_info});
%tempfile_info = %{ $stats{tempfile_info} } if (exists $stats{tempfile_info});
%logs_type = %{ $stats{logs_type} } if (exists $stats{logs_type});
%lock_info = %{ $stats{lock_info} } if (exists $stats{lock_info});
%per_minute_info = %{ $stats{per_minute_info} } if (exists $stats{per_minute_info});
%pgb_per_minute_info = %{ $stats{pgb_per_minute_info} } if (exists $stats{pgb_per_minute_info});
%top_slowest = %{ $stats{top_slowest} } if (exists $stats{top_slowest});
@log_files = @{ $stats{log_files} } if (exists $stats{log_files});
%autovacuum_info = %{ $stats{autovacuum_info} } if (exists $stats{autovacuum_info});
%autoanalyze_info = %{ $stats{autoanalyze_info} } if (exists $stats{autoanalyze_info});
%top_tempfile_info = %{ $stats{top_tempfile_info} } if (exists $stats{top_tempfile_info});
%top_locked_info = %{ $stats{top_locked_info} } if (exists $stats{top_locked_info});
%prepare_info = %{ $stats{prepare_info} } if (exists $stats{prepare_info});
%bind_info = %{ $stats{bind_info} } if (exists $stats{bind_info});
$nlines = $stats{nlines} if (exists $stats{nlines});
&logmsg('DEBUG', "binary statistics loaded from temporary file.");
}
else
{
&logmsg('WARNING', "could not load temporary binary file for multiple output generation.");
}
}
my $chld_running = 0;
foreach my $db (sort keys %DBLIST)
{
next if (!$db);
if ($nofork || $parallel_process <= 1) {
&gen_database_report($db);
}
else
{
while ($chld_running >= $parallel_process)
{
my $kid = waitpid(-1, WNOHANG);
if ($kid > 0)
{
$chld_running--;
delete $RUNNING_PIDS{$kid};
}
sleep(1);
}
spawn sub
{
&gen_database_report($db);
};
$chld_running++;
}
}
if (!$nofork && $parallel_process > 1)
{
while (scalar keys %RUNNING_PIDS > $progress)
{
my $kid = waitpid(-1, WNOHANG);
if ($kid > 0) {
delete $RUNNING_PIDS{$kid};
}
sleep(1);
}
}
}
elsif (!$incremental || !$noreport)
{
# Look for directory where report must be generated
my @build_directories = ();
if (-e "$last_parsed.tmp")
{
if (open(my $in, '<', "$last_parsed.tmp")) {
while (my $l = <$in>) {
chomp($l);
$l =~ s/\r//;
push(@build_directories, $l) if (!grep(/^$l$/, @build_directories));
}
close($in);
unlink("$last_parsed.tmp");
} else {
&logmsg('ERROR', "can't read file $last_parsed.tmp, $!");
}
&build_incremental_reports(@build_directories);
} else {
&logmsg('DEBUG', "no new entries in your log(s) since last run.");
}
}
my $t2 = Benchmark->new;
$td = timediff($t2, $t1);
&logmsg('DEBUG', "building reports took: " . timestr($td));
$td = timediff($t2, $t0);
&logmsg('DEBUG', "the total execution time took: " . timestr($td));
# Remove pidfile and temporary file
unlink($tmp_dblist);
unlink("$PID_FILE");
unlink("$last_parsed.tmp") if (-e "$last_parsed.tmp");
unlink($TMP_DIR . "/pgbadger_tmp_$$.bin") if ($#outfiles >= 1);
exit 0;
#-------------------------------------------------------------------------------
# Show pgBadger command line usage
sub usage
{
print qq{
Usage: pgbadger [options] logfile [...]
PostgreSQL log analyzer with fully detailed reports and graphs.
Arguments:
logfile can be a single log file, a list of files, or a shell command
returning a list of files. If you want to pass log content from stdin
use - as filename. Note that input from stdin will not work with csvlog.
Options:
-a | --average minutes : number of minutes to build the average graphs of
queries and connections. Default 5 minutes.
-A | --histo-average min: number of minutes to build the histogram graphs
of queries. Default 60 minutes.
-b | --begin datetime : start date/time for the data to be parsed in log
(either a timestamp or a time)
-c | --dbclient host : only report on entries for the given client host.
-C | --nocomment : remove comments like /* ... */ from queries.
-d | --dbname database : only report on entries for the given database.
-D | --dns-resolv : client ip addresses are replaced by their DNS name.
Be warned that this can really slow down pgBadger.
-e | --end datetime : end date/time for the data to be parsed in log
(either a timestamp or a time)
-E | --explode : explode the main report by generating one report
per database. Global information not related to a
database is added to the postgres database report.
-f | --format logtype : possible values: syslog, syslog2, stderr, jsonlog,
csv, pgbouncer, logplex, rds and redshift. Use this
option when pgBadger is not able to detect the log
format.
-G | --nograph : disable graphs on HTML output. Enabled by default.
-h | --help : show this message and exit.
-H | --html-outdir path: path to directory where HTML report must be written
in incremental mode, binary files stay on directory
defined with -O, --outdir option.
-i | --ident name : programname used as syslog ident. Default: postgres
-I | --incremental : use incremental mode, reports will be generated by
days in a separate directory, --outdir must be set.
-j | --jobs number : number of jobs to run at same time for a single log
file. Run as single by default or when working with
csvlog format.
-J | --Jobs number : number of log files to parse in parallel. Process
one file at a time by default.
-l | --last-parsed file: allow incremental log parsing by registering the
last datetime and line parsed. Useful if you want
to watch errors since last run or if you want one
report per day with a log rotated each week.
-L | --logfile-list file:file containing a list of log files to parse.
-m | --maxlength size : maximum length of a query, it will be restricted to
the given size. Default truncate size is $maxlength.
-M | --no-multiline : do not collect multiline statements to avoid garbage
especially on errors that generate a huge report.
-N | --appname name : only report on entries for given application name
-o | --outfile filename: define the filename for the output. Default depends
on the output format: out.html, out.txt, out.bin,
or out.json. This option can be used multiple times
to output several formats. To use json output, the
Perl module JSON::XS must be installed, to dump
output to stdout, use - as filename.
-O | --outdir path : directory where out files must be saved.
-p | --prefix string : the value of your custom log_line_prefix as
defined in your postgresql.conf. Only use it if you
aren't using one of the standard prefixes specified
in the pgBadger documentation, such as if your
prefix includes additional variables like client IP
or application name. MUST contain escape sequences
for time (%t, %m or %n) and processes (%p or %c).
See examples below.
-P | --no-prettify : disable SQL queries prettify formatter.
-q | --quiet : don't print anything to stdout, not even a progress
bar.
-Q | --query-numbering : add numbering of queries to the output when using
options --dump-all-queries or --normalized-only.
-r | --remote-host ip : set the host where to execute the cat command on
remote log file to parse the file locally.
-R | --retention N : number of weeks to keep in incremental mode. Defaults
to 0, disabled. Used to set the number of weeks to
keep in output directory. Older weeks and days
directories are automatically removed.
-s | --sample number : number of query samples to store. Default: 3.
-S | --select-only : only report SELECT queries.
-t | --top number : number of queries to store/display. Default: 20.
-T | --title string : change title of the HTML page report.
-u | --dbuser username : only report on entries for the given user.
-U | --exclude-user username : exclude entries for the specified user from
report. Can be used multiple time.
-v | --verbose : enable verbose or debug mode. Disabled by default.
-V | --version : show pgBadger version and exit.
-w | --watch-mode : only report errors just like logwatch could do.
-W | --wide-char : encode html output of queries into UTF8 to avoid
Perl message "Wide character in print".
-x | --extension : output format. Values: text, html, bin or json.
Default: html
-X | --extra-files : in incremental mode allow pgBadger to write CSS and
JS files in the output directory as separate files.
-z | --zcat exec_path : set the full path to the zcat program. Use it if
zcat, bzcat or unzip is not in your path.
-Z | --timezone +/-XX : Set the number of hours from GMT of the timezone.
Use this to adjust date/time in JavaScript graphs.
The value can be an integer, ex.: 2, or a float,
ex.: 2.5.
--anonymize : obscure all literals in queries, useful to hide
--charset : used to set the HTML charset to be used.
Default: utf-8.
--command CMD : command to execute to retrieve log entries on
stdin. pgBadger will open a pipe to the command
and parse log entries generated by the command.
--csv-separator : used to set the CSV field separator, default: ,
--day-report YYYY-MM-DD: create an HTML report over the specified day.
Requires incremental output directories and the
presence of all necessary binary data files
--disable-autovacuum : do not generate autovacuum report.
confidential data.
--disable-checkpoint : do not generate checkpoint/restartpoint report.
--disable-connection : do not generate connection report.
--disable-error : do not generate error report.
--disable-hourly : do not generate hourly report.
--disable-lock : do not generate lock report.
--disable-query : do not generate query reports (slowest, most
frequent, queries by users, by database, ...).
--disable-session : do not generate session report.
--disable-temporary : do not generate temporary report.
--disable-type : do not generate report of queries by type, database
or user.
--dump-all-queries : dump all queries found in the log file replacing
bind parameters included in the queries at their
respective placeholders positions.
--dump-raw-csv : parse the log and dump the information into CSV
format. No further processing is done, no report.
--enable-checksum : used to add an md5 sum under each query report.
--exclude-appname name : exclude entries for the specified application name
from report. Example: "pg_dump". Can be used
multiple times.
--exclude-client name : exclude log entries for the specified client ip.
Can be used multiple times.
--exclude-db name : exclude entries for the specified database from
report. Example: "postgres". Can be used multiple
times.
--exclude-file filename: path of the file that contains each regex to use
to exclude queries from the report. One regex per
line.
--exclude-line regex : exclude any log entry that will match the given
regex. Can be used multiple times.
--exclude-query regex : any query matching the given regex will be excluded
from the report. For example: "^(VACUUM|COMMIT)"
You can use this option multiple times.
--exclude-time regex : any timestamp matching the given regex will be
excluded from the report. Example: "2013-04-12 .*"
You can use this option multiple times.
--explain-url URL : use it to override the url of the graphical explain
tool. Default: $EXPLAIN_URL
--histogram-query VAL : use custom inbound for query times histogram.
Default inbound in milliseconds:
0,1,5,10,25,50,100,500,1000,10000
--histogram-session VAL: use custom inbound for session times histogram.
Default inbound in milliseconds:
0,500,1000,30000,60000,600000,1800000,3600000,28800000
--include-file filename: path of the file that contains each regex to the
queries to include from the report. One regex per
line.
--include-query regex : any query that does not match the given regex will
be excluded from the report. You can use this
option multiple times. For example: "(tbl1|tbl2)".
--include-pid PID : only report events related to the session pid (\%p).
Can be used multiple time.
--include-session ID : only report events related to the session id (\%c).
Can be used multiple time.
--include-time regex : only timestamps matching the given regex will be
included in the report. Example: "2013-04-12 .*"
You can use this option multiple times.
--iso-week-number : in incremental mode, calendar weeks start on
Monday and respect the ISO 8601 week number, range
01 to 53, where week 1 is the first week that has
at least 4 days in the new year.
--keep-comments : do not remove comments from normalized queries. It
can be useful if you want to distinguish between
same normalized queries.
--journalctl command : command to use to replace PostgreSQL logfile by
a call to journalctl. Basically it might be:
journalctl -u postgresql-9.5
--log-duration : force pgBadger to associate log entries generated
by both log_duration = on and log_statement = 'all'
--log-timezone +/-XX : Set the number of hours from GMT of the timezone
that must be used to adjust date/time read from
log file before beeing parsed. Using this option
makes log search with a date/time more difficult.
The value can be an integer, ex.: 2, or a float,
ex.: 2.5.
--month-report YYYY-MM : create a cumulative HTML report over the specified
month. Requires incremental output directories and
the presence of all necessary binary data files
--noexplain : do not process lines generated by auto_explain.
--no-fork : do not fork any process, for debugging purpose.
--no-process-info : disable changing process title to help identify
pgbadger process, some system do not support it.
--no-progressbar : disable progressbar.
--noreport : no reports will be created in incremental mode.
--no-week : inform pgbadger to not build weekly reports in
incremental mode. Useful if it takes too much time.
--normalized-only : only dump all normalized queries to out.txt
--pgbouncer-only : only show PgBouncer-related menus in the header.
--pid-dir path : set the path where the pid file must be stored.
Default /tmp
--pid-file file : set the name of the pid file to manage concurrent
execution of pgBadger. Default: pgbadger.pid
--pie-limit num : pie data lower than num% will show a sum instead.
--prettify-json : use it if you want json output to be prettified.
--rebuild : used to rebuild all html reports in incremental
output directories where there's binary data files.
--start-monday : in incremental mode, calendar weeks start on
Sunday. Use this option to start on a Monday.
--tempdir DIR : set directory where temporary files will be written
Default: File::Spec->tmpdir() || '/tmp'
pgBadger is able to parse a remote log file using a passwordless ssh connection.
Use -r or --remote-host to set the host IP address or hostname. There are also
some additional options to fully control the ssh connection.
--ssh-identity file path to the identity file to use.
--ssh-option options list of -o options to use for the ssh connection.
Options always used:
-o ConnectTimeout=\$ssh_timeout
-o PreferredAuthentications=hostbased,publickey
--ssh-port port ssh port to use for the connection. Default: 22.
--ssh-program ssh path to the ssh program to use. Default: ssh.
--ssh-timeout second timeout to ssh connection failure. Default: 10 sec.
--ssh-user username connection login name. Defaults to running user.
Log file to parse can also be specified using an URI, supported protocols are
http[s] and [s]ftp. The curl command will be used to download the file, and the
file will be parsed during download. The ssh protocol is also supported and will
use the ssh command like with the remote host use. See examples bellow.
Return codes:
0: on success
1: die on error
2: if it has been interrupted using ctr+c for example
3: the pid file already exists or can not be created
4: no log file was given at command line
Examples:
pgbadger /var/log/postgresql.log
pgbadger /var/log/postgres.log.2.gz /var/log/postgres.log.1.gz /var/log/postgres.log
pgbadger /var/log/postgresql/postgresql-2012-05-*
pgbadger --exclude-query="^(COPY|COMMIT)" /var/log/postgresql.log
pgbadger -b "2012-06-25 10:56:11" -e "2012-06-25 10:59:11" /var/log/postgresql.log
cat /var/log/postgres.log | pgbadger -
# Log line prefix with stderr log output
pgbadger --prefix '%t [%p]: user=%u,db=%d,client=%h' /pglog/postgresql-2012-08-21*
pgbadger --prefix '%m %u@%d %p %r %a : ' /pglog/postgresql.log
# Log line prefix with syslog log output
pgbadger --prefix 'user=%u,db=%d,client=%h,appname=%a' /pglog/postgresql-2012-08-21*
# Use my 8 CPUs to parse my 10GB file faster, much faster
pgbadger -j 8 /pglog/postgresql-10.1-main.log
Use URI notation for remote log file:
pgbadger http://172.12.110.1//var/log/postgresql/postgresql-10.1-main.log
pgbadger ftp://username\@172.12.110.14/postgresql-10.1-main.log
pgbadger ssh://username\@172.12.110.14:2222//var/log/postgresql/postgresql-10.1-main.log*
You can use together a local PostgreSQL log and a remote pgbouncer log file to parse:
pgbadger /var/log/postgresql/postgresql-10.1-main.log ssh://username\@172.12.110.14/pgbouncer.log
Reporting errors every week by cron job:
30 23 * * 1 /usr/bin/pgbadger -q -w /var/log/postgresql.log -o /var/reports/pg_errors.html
Generate report every week using incremental behavior:
0 4 * * 1 /usr/bin/pgbadger -q `find /var/log/ -mtime -7 -name "postgresql.log*"` -o /var/reports/pg_errors-`date +\\%F`.html -l /var/reports/pgbadger_incremental_file.dat
This supposes that your log file and HTML report are also rotated every week.
Or better, use the auto-generated incremental reports:
0 4 * * * /usr/bin/pgbadger -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/
will generate a report per day and per week.
In incremental mode, you can also specify the number of weeks to keep in the
reports:
/usr/bin/pgbadger --retention 2 -I -q /var/log/postgresql/postgresql.log.1 -O /var/www/pg_reports/
If you have a pg_dump at 23:00 and 13:00 each day during half an hour, you can
use pgBadger as follow to exclude these periods from the report:
pgbadger --exclude-time "2013-09-.* (23|13):.*" postgresql.log
This will help avoid having COPY statements, as generated by pg_dump, on top of
the list of slowest queries. You can also use --exclude-appname "pg_dump" to
solve this problem in a simpler way.
You can also parse journalctl output just as if it was a log file:
pgbadger --journalctl 'journalctl -u postgresql-9.5'
or worst, call it from a remote host:
pgbadger -r 192.168.1.159 --journalctl 'journalctl -u postgresql-9.5'
you don't need to specify any log file at command line, but if you have other
PostgreSQL log files to parse, you can add them as usual.
To rebuild all incremental html reports after, proceed as follow:
rm /path/to/reports/*.js
rm /path/to/reports/*.css
pgbadger -X -I -O /path/to/reports/ --rebuild
it will also update all resource files (JS and CSS). Use -E or --explode
if the reports were built using this option.
pgBadger also supports Heroku PostgreSQL logs using logplex format:
heroku logs -p postgres | pgbadger -f logplex -o heroku.html -
this will stream Heroku PostgreSQL log to pgbadger through stdin.
pgBadger can auto detect RDS and cloudwatch PostgreSQL logs using
rds format:
pgbadger -f rds -o rds_out.html rds.log
Each CloudSQL Postgresql log is a fairly normal PostgreSQL log, but encapsulated
in JSON format. It is autodetected by pgBadger but in case you need to force
the log format use `jsonlog`:
pgbadger -f jsonlog -o cloudsql_out.html cloudsql.log
This is the same as with the jsonlog extension, the json format is different
but pgBadger can parse both formats.
pgBadger also supports logs produced by CloudNativePG Postgres operator for Kubernetes:
pgbadger -f jsonlog -o cnpg_out.html cnpg.log
To create a cumulative report over a month use command:
pgbadger --month-report 2919-05 /path/to/incremental/reports/
this will add a link to the month name into the calendar view in
incremental reports to look at report for month 2019 May.
Use -E or --explode if the reports were built using this option.
};
# Note that usage must be terminated by an extra newline
# to not break POD documentation at make time.
exit 0;
}
sub gen_database_report
{
my $db = shift;
foreach $outfile (@outfiles)
{
($current_out_file, $extens) = &set_output_extension($outdir, $outfile, $extension, $db);
$extens = $dft_extens if ($current_out_file eq '-' && $dft_extens);
if ($report_per_database)
{
&logmsg('LOG', "Ok, generating $extens report for database $db...");
}
else
{
&logmsg('LOG', "Ok, generating $extens report...");
}
$fh = new IO::File ">$current_out_file";
if (not defined $fh) {
localdie("FATAL: can't write to $current_out_file, $!\n");
}
if (($extens eq 'text') || ($extens eq 'txt'))
{
if ($error_only) {
&dump_error_as_text($db);
} else {
&dump_as_text($db);
}
}
elsif ($extens eq 'json')
{
if ($error_only) {
&dump_error_as_json($db);
} else {
&dump_as_json($db);
}
}
elsif ($extens eq 'binary')
{
&dump_as_binary($fh, $db);
}
else
{
&dump_as_html('.', $db);
}
$fh->close;
}
}
####
# Function used to validate the possibility to use process on the given
# file. Returns 1 when all multiprocess can be used, 0 when we can not
# use multiprocess on a single file (remore file) and -1 when parallel
# process can not be used too (binary mode).
####
sub confirm_multiprocess
{
my $file = shift;
if (!$nofork && $progress)
{
# Not supported on Windows
if ($queue_size > 1) {
&logmsg('DEBUG', "parallel processing is not supported on this plateform.");
}
return 0;
}
if ($remote_host || $file =~ /^(http[s]*|ftp[s]*|ssh):/) {
# Disable multi process when using ssh to parse remote log
if ($queue_size > 1) {
&logmsg('DEBUG', "parallel processing is not supported with remote files.");
}
return 0;
}
# Disable parallel processing in binary mode
if ($format eq 'binary') {
if (($queue_size > 1) || ($job_per_file > 1)) {
&logmsg('DEBUG', "parallel processing is not supported with binary format.") if (!$quiet);
}
return -1;
}
return 1;
}
sub set_ssh_command
{
my ($ssh_cmd, $rhost) = @_;
#http://www.domain.com:8080/file.log:format
#ftp://www.domain.com/file.log:format
#ssh:root@domain.com:file.log:format
# Extract format part
my $fmt = '';
if ($rhost =~ s/\|([a-z2]+)$//) {
$fmt = $1;
}
$ssh_cmd = $ssh_bin || 'ssh';
$ssh_cmd .= " -p $ssh_port" if ($ssh_port);
$ssh_cmd .= " -i $ssh_identity" if ($ssh_identity);
$ssh_cmd .= " $ssh_options" if ($ssh_options);
if ($ssh_user && $rhost !~ /\@/) {
$ssh_cmd .= " $ssh_user\@$rhost";
} else {
$ssh_cmd .= " $rhost";
}
if (wantarray()) {
return ($ssh_cmd, $fmt);
} else {
return $ssh_cmd;
}
}
sub set_file_list
{
my $file = shift;
my @lfiles = ();
my $file_orig = $file;
my $fmt = '';
# Remove log format from log file if any
if ($file =~ s/(:(?:stderr|csv|syslog|pgbouncer|jsonlog|logplex|rds|redshift)\d*)$//i)
{
$fmt = $1;
}
# Store the journalctl command as is we will create a pipe from this command
if ( $journalctl_cmd && ($file =~ m/\Q$journalctl_cmd\E/) )
{
push(@lfiles, $file_orig);
$empty_files = 0;
}
# Store the journalctl command as is we will create a pipe from this command
elsif ( $log_command && ($file =~ m/\Q$log_command\E/) )
{
push(@lfiles, $file_orig);
$empty_files = 0;
}
# Input from stdin
elsif ($file eq '-')
{
if ($logfile_list)
{
localdie("FATAL: stdin input - can not be used with logfile list (-L).\n");
}
push(@lfiles, $file_orig);
$empty_files = 0;
}
# For input from other sources than stdin
else
{
# if it is not a remote file store the file if it is not an empty file
if (!$remote_host && $file !~ /^(http[s]*|[s]*ftp|ssh):/i)
{
localdie("FATAL: logfile \"$file\" must exist!\n") if (not -f $file);
if (-z $file)
{
print "WARNING: file $file is empty\n" if (!$quiet);
next;
}
push(@lfiles, $file_orig);
$empty_files = 0;
}
# if this is a remote file extract the list of files using a ssh command
elsif ($file !~ /^(http[s]*|[s]*ftp):/i)
{
# Get files from remote host
if ($file !~ /^ssh:/)
{
my($filename, $dirs, $suffix) = fileparse($file);
my $ssh_command_ls = "\"";
$ssh_command_ls .= "sudo " if ($ssh_sudo);
$ssh_command_ls .= "ls '$dirs'$filename\"";
&logmsg('DEBUG', "Looking for remote filename using command: $remote_command $ssh_command_ls");
my @rfiles = `$remote_command "ls '$dirs'$filename"`;
foreach my $f (@rfiles)
{
push(@lfiles, "$f$fmt");
}
}
elsif ($file =~ m#^ssh://([^\/]+)/(.*)#)
{
my $host_info = $1;
my $file = $2;
my $ssh = $ssh_command || 'ssh';
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
my($filename, $dirs, $suffix) = fileparse($file);
my $ssh_command_ls = "\"";
$ssh_command_ls .= "sudo " if ($ssh_sudo);
$ssh_command_ls .= "ls '$dirs'$filename\"";
&logmsg('DEBUG', "Looking for remote filename using command: $ssh $host_info $ssh_command_ls");
my @rfiles = `$ssh $host_info $ssh_command_ls`;
$dirs = '' if ( $filename ne '' ); #ls returns relative paths for an directory but absolute ones for a file or filename pattern
foreach my $f (@rfiles)
{
$host_info =~ s/-p (\d+) (.*)/$2:$1/;
push(@lfiles, "ssh://$host_info/$dirs$f$fmt");
}
}
$empty_files = 0;
}
# this is remote file extracted using http/ftp protocol, store the uri
else
{
push(@lfiles, $file_orig);
$empty_files = 0;
}
}
return @lfiles;
}
# Get inbounds of query times histogram
sub get_hist_inbound
{
my ($duration, @histogram) = @_;
for (my $i = 0; $i <= $#histogram; $i++) {
return $histogram[$i-1] if ($histogram[$i] > $duration);
}
return -1;
}
# Compile custom log line prefix prefix
sub set_parser_regex
{
my $fmt = shift;
@prefix_params = ();
@prefix_q_params = ();
if ($fmt eq 'pgbouncer')
{
$pgbouncer_log_format = qr/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\.\d+(?: [A-Z\+\-\d]{3,6})? (\d+) ([^\s]+) (.\-0x[0-9a-f\.]*): ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)(?:\(\d+\))??[:\d]* (.*)/;
@pgb_prefix_params = ('t_timestamp', 't_pid', 't_loglevel', 't_session_id', 't_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse1 = qr/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\.\d+(?: [A-Z\+\-\d]{3,6})? (\d+) ([^\s]+) (.\-0x[0-9a-f\.]+|[Ss]tats): (.*)/;
@pgb_prefix_parse1 = ('t_timestamp', 't_pid', 't_loglevel', 't_session_id', 't_query');
$pgbouncer_log_parse2 = qr/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+(?: [A-Z\+\-\d]{3,6})? \d+ [^\s]+ .\-0x[0-9a-f\.]*: ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?(?:\(\d+\))?(?:\(\d+\))?[:\d]* (.*)/;
@pgb_prefix_parse2 = ('t_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse3 = qr/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\.\d+(?: [A-Z\+\-\d]{3,6})? (\d+) ([^\s]+) ([^:]+: .*)/;
@pgb_prefix_parse3 = ('t_timestamp', 't_pid', 't_loglevel', 't_query');
}
elsif ($fmt eq 'pgbouncer1')
{
$pgbouncer_log_format = qr/^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]: (.\-0x[0-9a-f\.]*): ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?(?:\(\d+\))?[:\d]* (.*)/;
@pgb_prefix_params = ('t_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_session_id', 't_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse1 = qr/^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]: (.\-0x[0-9a-f\.]+|[Ss]tats): (.*)/;
@pgb_prefix_parse1 = ('t_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_session_id', 't_query');
$pgbouncer_log_parse2 = qr/^...\s+\d+\s\d+:\d+:\d+(?:\s[^\s]+)?\s[^\s]+\s[^\s\[]+\[\d+\]: .\-0x[0-9a-f\.]*: ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?(?:\(\d+\))?[:\d]* (.*)/;
@pgb_prefix_parse2 = ('t_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse3 = qr/^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]: ([^:]+: .*)/;
@pgb_prefix_parse3 = ('t_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_query');
}
elsif ($fmt eq 'pgbouncer2')
{
$pgbouncer_log_format = qr/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]: (.\-0x[0-9a-f\.]*): ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?(?:\(\d+\))?[:\d]* (.*)/;
@pgb_prefix_params = ('t_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_session_id', 't_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse1 = qr/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]: (.\-0x[0-9a-f\.]+|[Ss]tats): (.*)/;
@pgb_prefix_parse1 = ('t_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_session_id', 't_query');
$pgbouncer_log_parse2 = qr/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:.[^\s]+)?\s[^\s]+\s(?:[^\s]+\s)?(?:[^\s]+\s)?[^\s\[]+\[\d+\]: .\-0x[0-9a-f\.]*: ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?(?:\(\d+\))?[:\d]* (.*)/;
@pgb_prefix_parse2 = ('t_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse3 = qr/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]: ([^:]+: .*)/;
@pgb_prefix_parse3 = ('t_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_query');
}
elsif ($fmt eq 'pgbouncer3')
{
$pgbouncer_log_format = qr/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\.\d+(?: [A-Z\+\-\d]{3,6})? \[(\d+)\] ([^\s]+) (.\-0x[0-9a-f\.]*): ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)(?:\(\d+\))??[:\d]* (.*)/;
@pgb_prefix_params = ('t_timestamp', 't_pid', 't_loglevel', 't_session_id', 't_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse1 = qr/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\.\d+(?: [A-Z\+\-\d]{3,6})? \[(\d+)\] ([^\s]+) (.\-0x[0-9a-f\.]+|[Ss]tats): (.*)/;
@pgb_prefix_parse1 = ('t_timestamp', 't_pid', 't_loglevel', 't_session_id', 't_query');
$pgbouncer_log_parse2 = qr/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+(?: [A-Z\+\-\d]{3,6})? \[\d+\] [^\s]+ .\-0x[0-9a-f\.]*: ([0-9a-zA-Z\_\[\]\-\.]*)\/([0-9a-zA-Z\_\[\]\-\.]*)\@([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?(?:\(\d+\))?(?:\(\d+\))?[:\d]* (.*)/;
@pgb_prefix_parse2 = ('t_dbname', 't_dbuser', 't_client', 't_query');
$pgbouncer_log_parse3 = qr/^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\.\d+(?: [A-Z\+\-\d]{3,6})? \[(\d+)\] ([^\s]+) ([^:]+: .*)/;
@pgb_prefix_parse3 = ('t_timestamp', 't_pid', 't_loglevel', 't_query');
}
elsif ($log_line_prefix)
{
# Build parameters name that will be extracted from the prefix regexp
my %res = &build_log_line_prefix_regex($log_line_prefix);
my $llp = $res{'llp'};
@prefix_params = @{ $res{'param_list'} };
$q_prefix = $res{'q_prefix'};
@prefix_q_params = @{ $res{'q_param_list'} };
if ($fmt eq 'syslog')
{
$llp =
'^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(\.\d+)?(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?\s\[(\d+)(?:\-\d+)?\]\s*'
. $llp
. '\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)';
$compiled_prefix = qr/$llp/;
unshift(@prefix_params, 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_ms', 't_host', 't_ident', 't_pid', 't_session_line');
push(@prefix_params, 't_loglevel', 't_query');
$other_syslog_line = qr/^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?\s\[(\d+)(?:\-\d+)?\]\s*(.*)/;
}
elsif ($fmt eq 'syslog2')
{
$fmt = 'syslog';
$llp =
'^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?(?:\s\[(\d+)(?:\-\d+)?\])?\s*'
. $llp
. '\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)';
$compiled_prefix = qr/$llp/;
unshift(@prefix_params, 't_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_session_line');
push(@prefix_params, 't_loglevel', 't_query');
$other_syslog_line = qr/^(\d+-\d+)-(\d+)T(\d+):(\d+):(\d+)(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?(?:\s\[(\d+)(?:\-\d+)?\])?\s*(.*)/;
}
elsif ($fmt eq 'logplex')
{
# The output format of the heroku pg logs is as follows: timestamp app[dyno]: message
$llp =
'^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)(\.\d+)?[+\-]\d{2}:\d{2}\s+(?:[^\s]+)?\s*app\[postgres\.(\d+)\][:]?\s+\[([^\]]+)\]\s+\[\d+\-\d+\]\s+'
. $llp
. '\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(.*)';
$compiled_prefix = qr/$llp/;
unshift(@prefix_params, 't_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_ms', 't_pid', 't_dbname');
push(@prefix_params, 't_loglevel', 't_query');
$other_syslog_line = qr/^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)(?:\.\d+)?[+\-]\d{2}:\d{2}\s+(?:[^\s]+)?\s*app\[postgres\.\d+\][:]?\s+\[([^\]]+)\]\s+\[(\d+)\-(\d+)\]\s*(.*)/;
}
elsif ($fmt =~ /^rds$/)
{
# The output format of the RDS pg logs is as follows: %t:%r:%u@%d:[%p]: message
# With Cloudwatch it is prefixed with another timestamp
$llp = '^' . $llp
. '(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(.*)';
$compiled_prefix = qr/$llp/;
@prefix_params = ('t_timestamp', 't_client', 't_dbuser', 't_dbname', 't_pid', 't_loglevel', 't_query');
}
elsif ($fmt =~ /^redshift$/)
{
# Look at format of the AWS redshift pg logs, for example:
# '2020-03-07T16:09:43Z UTC [ db=dev user=rdsdb pid=16929 userid=1 xid=7382 ]'
$llp = '^' . $llp
. '(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(.*)';
$compiled_prefix = qr/$llp/;
@prefix_params = ('t_timestamp', 't_dbname', 't_dbuser', 't_pid', 't_loglevel', 't_query');
}
elsif ($fmt eq 'stderr' || $fmt eq 'default' || $fmt eq 'jsonlog')
{
$fmt = 'stderr' if ($fmt ne 'jsonlog');
$llp = '^' . $llp . '\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)';
$compiled_prefix = qr/$llp/;
push(@prefix_params, 't_loglevel', 't_query');
}
}
elsif ($fmt eq 'syslog')
{
$compiled_prefix =
qr/^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(\.\d+)?(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?\s\[(\d+)(?:\-\d+)?\]\s*(.*?)\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)/;
push(@prefix_params, 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_ms', 't_host', 't_ident', 't_pid', 't_session_line',
't_logprefix', 't_loglevel', 't_query');
$other_syslog_line = qr/^(...)\s+(\d+)\s(\d+):(\d+):(\d+)(?:\.\d+)?(?:\s[^\s]+)?\s([^\s]+)\s([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?\s\[(\d+)(?:\-\d+)?\]\s*(.*)/;
}
elsif ($fmt eq 'syslog2')
{
$fmt = 'syslog';
$compiled_prefix =
qr/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?(?:\s\[(\d+)(?:\-\d+)?\])?\s*(.*?)\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)/;
push(@prefix_params, 't_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_host', 't_ident', 't_pid', 't_session_line',
't_logprefix', 't_loglevel', 't_query');
$other_syslog_line = qr/^(\d+-\d+)-(\d+)T(\d+):(\d+):(\d+)(?:.[^\s]+)?\s([^\s]+)\s(?:[^\s]+\s)?(?:[^\s]+\s)?([^\s\[]+)\[(\d+)\]:(?:\s\[[^\]]+\])?(?:\s\[(\d+)(?:\-\d+)?\])?\s*(.*)/;
}
elsif ($fmt eq 'logplex')
{
# The output format of the heroku pg logs is as follows: timestamp app[dyno]: message
$compiled_prefix =
qr/^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)(\.\d+)?[+\-]\d{2}:\d{2}\s+(?:[^\s]+)?\s*app\[postgres\.(\d+)\][:]?\s+\[([^\]]+)\]\s+\[\d+\-\d+\]\s+(.*?)\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(.*)/;
unshift(@prefix_params, 't_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_ms', 't_pid', 't_dbname');
push(@prefix_params, 't_logprefix', 't_loglevel', 't_query');
$other_syslog_line = qr/^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)(?:\.\d+)?[+\-]\d{2}:\d{2}\s+(?:[^\s]+)?\s*app\[(postgres)\.(\d+)\][:]?\s+\[([^\]]+)\]\s+\[\d+\-\d+\]\s*(.*)/;
}
elsif ($fmt eq 'rds')
{
# The output format of the RDS pg logs is as follows: %t:%r:%u@%d:[%p]: message
# With Cloudwatch it is prefixed with another timestamp
$compiled_prefix =
qr/^(?:\d+-\d+-\d+T\d+:\d+:\d+\.\d+Z)?\s*(\d+)-(\d+)-(\d+) (\d+):(\d+):(\d+)\s*[^:]*:([^:]*):([^\@]*)\@([^:]*):\[(\d+)\]:(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(.*)/;
unshift(@prefix_params, 't_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_client', 't_dbuser', 't_dbname', 't_pid', 't_loglevel', 't_query');
}
elsif ($fmt eq 'redshift')
{
# Look at format of the AWS redshift pg logs, for example:
# '2020-03-07T16:09:43Z UTC [ db=dev user=rdsdb pid=16929 userid=1 xid=7382 ]'
$compiled_prefix =
qr/^'(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)Z [^\s]+ \[ db=(.*?) user=(.*?) pid=(\d+) userid=\d+ xid=(?:.*?) \]' (LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(.*)/;
unshift(@prefix_params, 't_year', 't_month', 't_day', 't_hour', 't_min', 't_sec', 't_dbname', 't_dbuser', 't_pid', 't_loglevel', 't_query');
}
elsif ($fmt eq 'stderr')
{
$compiled_prefix =
qr/^(\d{10}\.\d{3}|\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2})(\.\d+)?(?: [A-Z\+\-\d]{3,6})?\s\[([0-9a-f\.]+)\][:]*\s(?:\[\d+\-\d+\])?\s*(.*?)\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)/;
push(@prefix_params, 't_timestamp', 't_ms', 't_pid', 't_logprefix', 't_loglevel', 't_query');
}
elsif ($fmt eq 'default')
{
$fmt = 'stderr';
$compiled_prefix =
qr/^(\d{10}\.\d{3}|\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2})(\.\d+)?(?: [A-Z\+\-\d]{3,6})?\s\[([0-9a-f\.]+)\][:]*\s(.*?)\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)/;
push(@prefix_params, 't_timestamp', 't_ms', 't_pid', 't_logprefix', 't_loglevel', 't_query');
}
return $fmt;
}
sub check_regex
{
my ($pattern, $varname) = @_;
eval {m/$pattern/i;};
if ($@) {
localdie("FATAL: '$varname' invalid regex '$pattern', $!\n");
}
}
sub build_incremental_reports
{
my @build_directories = @_;
my $destdir = $html_outdir || $outdir;
my %weeks_directories = ();
foreach my $bpath (sort @build_directories)
{
my $binpath = '';
$binpath = $1 if ($bpath =~ s/^(.*\/)(\d+\-\d+\-\d+)$/$2/);
&logmsg('DEBUG', "Building incremental report for " . $bpath);
$incr_date = $bpath;
$last_incr_date = $bpath;
# Set the path to binary files
$bpath =~ s/\-/\//g;
# Get the week number following the date
$incr_date =~ /^(\d+)-(\d+)\-(\d+)$/;
my $wn = &get_week_number($1, $2, $3);
if (!$noweekreport)
{
if ($rebuild || !exists $weeks_directories{$wn})
{
$weeks_directories{$wn}{dir} = "$1-$2";
$weeks_directories{$wn}{prefix} = $binpath if ($binpath);
}
}
# First clear previous stored statistics
&init_stats_vars();
# Load all data gathered by all the different processes
$destdir = $binpath || $outdir;
if (opendir(DIR, "$destdir/$bpath"))
{
my @mfiles = grep { !/^\./ && ($_ =~ /\.bin$/) } readdir(DIR);
closedir DIR;
foreach my $f (@mfiles)
{
my $fht = new IO::File;
$fht->open("< $destdir/$bpath/$f") or localdie("FATAL: can't open file $destdir/$bpath/$f, $!\n");
load_stats($fht);
$fht->close();
}
}
$destdir = $html_outdir || $outdir;
foreach my $db (sort keys %DBLIST)
{
#next if ($#dbname >= 0 and !grep(/^$db$/i, @dbname));
my $tmp_dir = "$destdir/$db";
$tmp_dir = $destdir if (!$report_per_database);
# Generate reports for each specified output format
foreach $outfile (@outfiles)
{
my ($out_filename, $out_ext) = &set_output_extension('', $outfile, '', $db);
$extens = $out_ext;
$current_out_file = $out_filename;
&logmsg('LOG', "Ok, generating $extens daily report into $tmp_dir/$bpath/...");
# set path and create subdirectories
mkdir("$tmp_dir") if (!-d "$tmp_dir");
if ($bpath =~ m#^(\d+)/(\d+)/(\d+)#)
{
mkdir("$tmp_dir/$1") if (!-d "$tmp_dir/$1");
mkdir("$tmp_dir/$1/$2") if (!-d "$tmp_dir/$1/$2");
mkdir("$tmp_dir/$1/$2/$3") if (!-d "$tmp_dir/$1/$2/$3");
}
else
{
&logmsg('ERROR', "invalid path: $bpath, can not create subdirectories.");
}
$fh = new IO::File ">$tmp_dir/$bpath/$current_out_file";
if (not defined $fh) {
localdie("FATAL: can't write to $tmp_dir/$bpath/$current_out_file, $!\n");
}
if (($extens eq 'text') || ($extens eq 'txt'))
{
if ($error_only) {
&dump_error_as_text($db);
} else {
&dump_as_text($db);
}
}
elsif ($extens eq 'json')
{
if ($error_only) {
&dump_error_as_json($db);
} else {
&dump_as_json($db);
}
}
else
{
&dump_as_html('../../..', $db);
}
$fh->close;
}
}
}
# Build a report per week
foreach my $wn (sort { $a <=> $b } keys %weeks_directories)
{
&init_stats_vars();
# Get all days of the current week
my $getwnb = $wn;
$getwnb-- if (!$iso_week_number);
my @wdays = &get_wdays_per_month($getwnb, $weeks_directories{$wn}{dir});
my $binpath = '';
$binpath = $weeks_directories{$wn}{prefix} if (defined $weeks_directories{$wn}{prefix});
my $wdir = '';
# Load data per day
foreach my $bpath (@wdays)
{
$incr_date = $bpath;
$bpath =~ s/\-/\//g;
$incr_date =~ /^(\d+)\-(\d+)\-(\d+)$/;
$wdir = "$1/week-$wn";
$destdir = $binpath || $outdir;
# Load all data gathered by all the differents processes
if (-e "$destdir/$bpath")
{
unless(opendir(DIR, "$destdir/$bpath")) {
localdie("FATAL: can't opendir $destdir/$bpath: $!\n");
}
my @mfiles = grep { !/^\./ && ($_ =~ /\.bin$/) } readdir(DIR);
closedir DIR;
foreach my $f (@mfiles)
{
my $fht = new IO::File;
$fht->open("< $destdir/$bpath/$f") or localdie("FATAL: can't open file $destdir/$bpath/$f, $!\n");
load_stats($fht);
$fht->close();
}
}
}
$destdir = $html_outdir || $outdir;
foreach my $db (sort keys %DBLIST)
{
#next if ($#dbname >= 0 and !grep(/^$db$/i, @dbname));
my $tmp_dir = "$destdir/$db";
$tmp_dir = $destdir if (!$report_per_database);
# Generate reports for each specified output format
foreach $outfile (@outfiles)
{
my ($out_filename, $out_ext) = &set_output_extension('', $outfile, '', $db);
$extens = $out_ext;
$current_out_file = $out_filename;
&logmsg('LOG', "Ok, generating $extens weekly report into $tmp_dir/$wdir/...");
mkdir("$tmp_dir") if (!-d "$tmp_dir");
my $path = $tmp_dir;
foreach my $d (split('/', $wdir))
{
mkdir("$path/$d") if (!-d "$path/$d");
$path .= "/$d";
}
$fh = new IO::File ">$tmp_dir/$wdir/$current_out_file";
if (not defined $fh) {
localdie("FATAL: can't write to $tmp_dir/$wdir/$current_out_file, $!\n");
}
if (($extens eq 'text') || ($extens eq 'txt'))
{
if ($error_only) {
&dump_error_as_text($db);
} else {
&dump_as_text($db);
}
}
elsif ($extens eq 'json')
{
if ($error_only) {
&dump_error_as_json($db);
} else {
&dump_as_json($db);
}
}
else
{
&dump_as_html('../..', $db);
}
$fh->close;
}
}
}
# Generate global index to access incremental reports
&build_global_index();
}
sub build_month_reports
{
my ($month_path, @build_directories) = @_;
# First clear previous stored statistics
&init_stats_vars();
foreach my $bpath (sort @build_directories) {
$incr_date = $bpath;
$last_incr_date = $bpath;
# Set the path to binary files
$bpath =~ s/\-/\//g;
# Get the week number following the date
$incr_date =~ /^(\d+)-(\d+)\-(\d+)$/;
&logmsg('DEBUG', "reading month statistics from $outdir/$bpath");
# Load all data gathered by all the different processes
unless(opendir(DIR, "$outdir/$bpath")) {
localdie("FATAL: can't opendir $outdir/$bpath: $!\n");
}
my @mfiles = grep { !/^\./ && ($_ =~ /\.bin$/) } readdir(DIR);
closedir DIR;
foreach my $f (@mfiles) {
my $fht = new IO::File;
$fht->open("< $outdir/$bpath/$f") or localdie("FATAL: can't open file $outdir/$bpath/$f, $!\n");
load_stats($fht);
$fht->close();
}
}
my $dest_dir = $html_outdir || $outdir;
foreach my $db (sort keys %DBLIST)
{
my $tmp_dir = "$dest_dir/$db";
$tmp_dir = $dest_dir if (!$report_per_database);
# Generate reports for each specified output format
foreach $outfile (@outfiles)
{
my ($out_filename, $out_ext) = &set_output_extension('', $outfile, '', $db);
$extens = $out_ext;
$current_out_file = $out_filename;
&logmsg('LOG', "Ok, generating $extens monthly report into $tmp_dir/$month_path/$current_out_file");
mkdir("$tmp_dir") if (!-d "$tmp_dir");
my $path = $tmp_dir;
foreach my $d (split('/', $month_path)) {
mkdir("$path/$d") if (!-d "$path/$d");
$path .= "/$d";
}
$fh = new IO::File ">$tmp_dir/$month_path/$current_out_file";
if (not defined $fh) {
localdie("FATAL: can't write to $tmp_dir/$month_path/$current_out_file, $!\n");
}
if (($extens eq 'text') || ($extens eq 'txt'))
{
if ($error_only) {
&dump_error_as_text($db);
} else {
&dump_as_text($db);
}
}
elsif ($extens eq 'json')
{
if ($error_only) {
&dump_error_as_json($db);
} else {
&dump_as_json($db);
}
}
else
{
&dump_as_html('../..', $db);
}
$fh->close;
}
}
# Generate global index to access incremental reports
&build_global_index();
}
sub build_day_reports
{
my ($day_path, @build_directories) = @_;
# First clear previous stored statistics
&init_stats_vars();
foreach my $bpath (sort @build_directories) {
$incr_date = $bpath;
$last_incr_date = $bpath;
# Set the path to binary files
$bpath =~ s/\-/\//g;
# Get the week number following the date
$incr_date =~ /^(\d+)-(\d+)\-(\d+)$/;
&logmsg('DEBUG', "reading month statistics from $outdir/$bpath");
# Load all data gathered by all the different processes
unless(opendir(DIR, "$outdir/$bpath")) {
localdie("FATAL: can't opendir $outdir/$bpath: $!\n");
}
my @mfiles = grep { !/^\./ && ($_ =~ /\.bin$/) } readdir(DIR);
closedir DIR;
foreach my $f (@mfiles) {
my $fht = new IO::File;
$fht->open("< $outdir/$bpath/$f") or localdie("FATAL: can't open file $outdir/$bpath/$f, $!\n");
load_stats($fht);
$fht->close();
}
}
my $dest_dir = $html_outdir || $outdir;
foreach my $db (sort keys %DBLIST)
{
my $tmp_dir = "$dest_dir/$db";
$tmp_dir = $dest_dir if (!$report_per_database);
# Generate reports for each specified output format
foreach $outfile (@outfiles)
{
my ($out_filename, $out_ext) = &set_output_extension('', $outfile, '', $db);
$extens = $out_ext;
$current_out_file = $out_filename;
&logmsg('LOG', "Ok, generating $extens daily report into $tmp_dir/$day_path/$current_out_file");
mkdir("$tmp_dir") if (!-d "$tmp_dir");
my $path = $tmp_dir;
foreach my $d (split('/', $day_path))
{
mkdir("$path/$d") if (!-d "$path/$d");
$path .= "/$d";
}
$fh = new IO::File ">$tmp_dir/$day_path/$current_out_file";
if (not defined $fh) {
localdie("FATAL: can't write to $tmp_dir/$day_path/$current_out_file, $!\n");
}
if (($extens eq 'text') || ($extens eq 'txt'))
{
if ($error_only) {
&dump_error_as_text($db);
} else {
&dump_as_text($db);
}
}
elsif ($extens eq 'json')
{
if ($error_only) {
&dump_error_as_json($db);
} else {
&dump_as_json($db);
}
}
else
{
&dump_as_html('../..', $db);
}
$fh->close;
}
}
# Generate global index to access incremental reports
&build_global_index();
}
sub build_global_index
{
&logmsg('LOG', "Ok, generating global index to access incremental reports...");
my $dest_dir = $html_outdir || $outdir;
# Get database directories
unless(opendir(DIR, "$dest_dir")) {
localdie("FATAL: can't opendir $dest_dir: $!\n");
}
my @dbs = grep { !/^\./ && !/^\d{4}$/ && -d "$dest_dir/$_" } readdir(DIR);
closedir DIR;
@dbs = ($DBALL) if (!$report_per_database);
foreach my $db (@dbs)
{
#next if ($#dbname >= 0 and !grep(/^$db$/i, @dbname));
my $tmp_dir = "$dest_dir/$db";
$tmp_dir = $dest_dir if (!$report_per_database);
&logmsg('DEBUG', "writing global index into $tmp_dir/index.html");
$fh = new IO::File ">$tmp_dir/index.html";
if (not defined $fh) {
localdie("FATAL: can't write to $tmp_dir/index.html, $!\n");
}
my $date = localtime(time);
my @tmpjscode = @jscode;
my $path_prefix = '.';
$path_prefix = '..' if ($report_per_database);
for (my $i = 0; $i <= $#tmpjscode; $i++) {
$tmpjscode[$i] =~ s/EDIT_URI/$path_prefix/;
}
my $local_title = 'Global Index on incremental reports';
if ($report_title) {
$local_title = 'Global Index - ' . $report_title;
}
print $fh qq{
pgBadger :: $local_title
@tmpjscode
};
}
sub print_vacuum_per_table
{
my $curdb = shift;
# VACUUM stats per table
my $total_count = 0;
my $total_idxscan = 0;
my $total_hits = 0;
my $total_misses = 0;
my $total_dirtied = 0;
my $total_skippins = 0;
my $total_skipfrozen = 0;
my $total_records = 0;
my $total_full_page = 0;
my $total_bytes = 0;
my $total_pages_frozen = 0;
my $total_tuples_frozen = 0;
my $vacuum_info = '';
my @main_vacuum = ('unknown',0);
foreach my $t (sort {
$autovacuum_info{$curdb}{tables}{$b}{vacuums} <=> $autovacuum_info{$curdb}{tables}{$a}{vacuums}
} keys %{$autovacuum_info{$curdb}{tables}})
{
$vacuum_info .= "
};
delete $drawn_graphs{queriesbyhost_graph};
}
sub display_plan
{
my ($id, $plan) = @_;
# Only TEXT format plan can be sent to Depesz site.
if ($plan !~ /Node Type:|"Node Type":|Node-Type/s) {
return "
};
&print_overall_statistics($curdb);
}
if (!$disable_hourly && !$pgbouncer_only)
{
# Build graphs based on hourly stat
&compute_query_graphs($curdb);
# Show global SQL traffic
&print_sql_traffic($curdb);
# Show hourly statistics
&print_general_activity($curdb);
}
if (!$disable_connection && !$pgbouncer_only)
{
print $fh qq{
Connections
};
# Draw connections information
&print_established_connection($curdb) if (!$disable_hourly);
# Show per database/user connections
&print_database_connection($curdb);
# Show per user connections
&print_user_connection($curdb);
# Show per client ip connections
&print_host_connection($curdb);
}
# Show session per database statistics
if (!$disable_session && !$pgbouncer_only)
{
print $fh qq{
Sessions
};
# Show number of simultaneous sessions
&print_simultaneous_session($curdb);
# Show histogram for session times
&print_histogram_session_times($curdb);
# Show per database sessions
&print_database_session($curdb);
# Show per user sessions
&print_user_session($curdb);
# Show per host sessions
&print_host_session($curdb);
# Show per application sessions
&print_app_session($curdb);
}
# Display checkpoint and temporary files report
if (!$disable_checkpoint && !$pgbouncer_only && (!$report_per_database || $curdb eq $DBALL)) {
print $fh qq{
};
# Show temporary files detailed information
&print_temporary_file($curdb);
# Show information about queries generating temporary files
&print_tempfile_report($curdb);
}
if (!$disable_autovacuum && !$pgbouncer_only)
{
print $fh qq{
};
# Show detailed vacuum/analyse information
&print_vacuum($curdb);
}
if (!$disable_lock && !$pgbouncer_only)
{
print $fh qq{
};
# Lock stats per type
&print_lock_type($curdb);
# Show lock wait detailed information
&print_lock_queries_report($curdb);
}
if (!$disable_query && !$pgbouncer_only)
{
print $fh qq{
};
# INSERT/DELETE/UPDATE/SELECT repartition
if (!$disable_type)
{
&print_query_type($curdb);
# Show requests per database
&print_query_per_database($curdb);
# Show requests per user
&print_query_per_user($curdb);
# Show requests per host
&print_query_per_host($curdb);
# Show requests per application
&print_query_per_application($curdb);
;
# Show cancelled queries detailed information
&print_cancelled_queries($curdb);
# Show information about cancelled queries
&print_cancelled_report($curdb);
}
print $fh qq{
};
# Show histogram for query times
&print_histogram_query_times($curdb);
# Show top information
&print_slowest_individual_queries($curdb);
# Show queries that took up the most time
&print_time_consuming($curdb);
# Show most frequent queries
&print_most_frequent($curdb);
# Print normalized slowest queries
&print_slowest_queries($curdb);
# Show prepare that took up the most time
&print_prepare_consuming($curdb);
# Show bind that took up the most time
&print_bind_consuming($curdb);
}
# Show pgbouncer sessions and connections statistics
if (exists $pgb_overall_stat{peak} && (!$report_per_database || $curdb eq $DBALL))
{
# Build pgbouncer graph based on hourly stats
&compute_pgbouncer_graphs();
my $active = '';
$active = ' active-slide' if ($pgbouncer_only);
print $fh qq{
pgBouncer
};
# Draw pgbouncer own statistics
&print_pgbouncer_stats() if (!$disable_hourly);
# Draw connections information
&print_established_pgb_connection() if (!$disable_hourly);
# Show per database/user connections
&print_database_pgb_connection();
# Show per user connections
&print_user_pgb_connection();
# Show per client ip connections
&print_host_pgb_connection();
# Show number of simultaneous sessions
&print_simultaneous_pgb_session();
# Show histogram for session times
&print_histogram_pgb_session_times();
# Show per database sessions
&print_database_pgb_session();
# Show per user sessions
&print_user_pgb_session();
# Show per host sessions
&print_host_pgb_session();
# Show most used reserved pool
&show_pgb_reserved_pool();
# Show Most Frequent Errors/Events
&show_pgb_error_as_html();
}
}
# Show errors report
if (!$disable_error)
{
if (!$error_only)
{
print $fh qq{
};
} else {
print $fh qq{
};
}
# Show log level distribution
&print_log_level($curdb);
# Show error code distribution
&print_error_code($curdb) if (scalar keys %errors_code > 0);
# Show Most Frequent Errors/Events
&show_error_as_html($curdb);
}
# Dump the html footer
&html_footer($curdb);
}
sub url_escape
{
my $toencode = shift;
return if (!$toencode);
utf8::encode($toencode) if (($] >= 5.008) && utf8::is_utf8($toencode));
if (EBCDIC) {
$toencode =~ s/([^a-zA-Z0-9_.~-])/uc sprintf("%%%02x",$E2A[ord($1)])/eg;
} else {
$toencode =~ s/([^a-zA-Z0-9_.~-])/uc sprintf("%%%02x",ord($1))/eg;
}
return $toencode;
}
sub escape_html
{
$_[0] =~ s/<([\/a-zA-Z][\s\>]*)/\<$1/sg;
return $_[0];
}
sub print_log_level
{
my $curdb = shift;
my %infos = ();
# Show log types
my $total_logs = 0;
foreach my $d (sort keys %{$logs_type{$curdb}}) {
$total_logs += $logs_type{$curdb}{$d};
}
my $logtype_info = '';
foreach my $d (sort keys %{$logs_type{$curdb}}) {
next if (!$logs_type{$curdb}{$d});
$logtype_info .= "
};
}
my $datadef = '';
foreach my $k (sort keys %data) {
$datadef .= "['$k', $data{$k}],";
}
$datadef =~ s/,$//;
return <
EOF
}
sub jqplot_histograph
{
my ($buttonid, $divid, $data1, $data2, $legend1, $legend2) = @_;
if (!$data1) {
return qq{
NO DATASET
};
}
$legend1 ||= 'Queries';
my $y2decl = '';
my $y2vals = '';
if ($data2) {
$legend2 ||= 'Avg. duration';
$y2decl = "var lines_${buttonid} = [$data2];";
$y2vals = ", lines_${buttonid}";
}
my $title = '';
return <
EOF
}
sub jqplot_duration_histograph
{
my ($buttonid, $divid, $legend, $range, %data) = @_;
if (scalar keys %data == 0) {
return qq{
NO DATASET
};
}
$legend ||= 'Queries';
my $bars = '';
for (my $i = 1; $i <= $#{$range}; $i++) {
my $k = "$range->[$i-1]-$range->[$i]ms";
my $lbl = "'" . &convert_time($range->[$i-1]) . '-' . &convert_time($range->[$i]) . "'";
$bars .= "[ $lbl, $data{$k}],";
}
my $k = "> $range->[-1]ms";
$bars .= "[ '> " . &convert_time($range->[-1]) . "', $data{$k}]";
my $title = '';
return <
EOF
}
sub build_log_line_prefix_regex
{
my $llp = shift;
my %regex_map = (
'%a' => [('t_appname', '(.*?)')], # application name
'%u' => [('t_dbuser', '([0-9a-zA-Z\_\[\]\-\.]*)')], # user name
'%d' => [('t_dbname', '([0-9a-zA-Z\_\[\]\-\.]*)')], # database name
'%r' => [('t_hostport', '([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?[\(\d+\)]*')], # remote host and port
'%h' => [('t_client', '([a-zA-Z0-9\-\.]+|\[local\]|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[0-9a-fA-F:]+)?')], # remote host
'%p' => [('t_pid', '(\d+)')], # process ID
'%Q' => [('t_queryid', '([\-]*\d+)')], # Query ID
'%n' => [('t_epoch', '(\d{10}\.\d{3})')], # timestamp as Unix epoch
'%t' => [('t_timestamp', '(\d{4}-\d{2}-\d{2}[\sT]\d{2}:\d{2}:\d{2})[Z]*(?:[ \+\-][A-Z\+\-\d]{3,6})?')], # timestamp without milliseconds
'%m' => [('t_mtimestamp', '(\d{4}-\d{2}-\d{2}[\sT]\d{2}:\d{2}:\d{2}\.\d+)(?:[ \+\-][A-Z\+\-\d]{3,6})?')], # timestamp with milliseconds
'%l' => [('t_session_line', '(\d+)')], # session line number
'%s' => [('t_session_timestamp', '(\d{4}-\d{2}-\d{2}[\sT]\d{2}):\d{2}:\d{2}(?:[ \+\-][A-Z\+\-\d]{3,6})?')], # session start timestamp
'%c' => [('t_session_id', '([0-9a-f\.]*)')], # session ID
'%v' => [('t_virtual_xid', '([0-9a-f\.\/]*)')], # virtual transaction ID
'%x' => [('t_xid', '([0-9a-f\.\/]*)')], # transaction ID
'%i' => [('t_command', '([0-9a-zA-Z\.\-\_\s]*)')], # command tag
'%e' => [('t_sqlstate', '([0-9a-zA-Z]+)')], # SQL state
'%b' => [('t_backend_type', '(.*?)')], # backend type
);
my $param_list = [];
$llp =~ s/([\[\]\|\(\)\{\}])/\\$1/g;
$llp =~ s/\%l([^\d])\d+/\%l$1\\d\+/;
my $q_prefix = '';
if ($llp =~ s/(.*)\%q(.*)/$1$2/) {
$q_prefix = $1;
}
while ($llp =~ s/(\%[audrhpQntmlscvxieb])/$regex_map{"$1"}->[1]/) {
push(@$param_list, $regex_map{"$1"}->[0]);
}
my $q_prefix_param = [];
if ($q_prefix) {
while ($q_prefix =~ s/(\%[audrhpQntmlscvxieb])/$regex_map{"$1"}->[1]/) {
push(@$q_prefix_param, $regex_map{"$1"}->[0]);
}
push(@$q_prefix_param, 't_loglevel', 't_query');
}
# replace %% by a single %
$llp =~ s/\%\%/\%/g;
$q_prefix =~ s/\%\%/\%/g;
$q_prefix = qr/$q_prefix\s*(LOG|WARNING|ERROR|FATAL|PANIC|DETAIL|STATEMENT|HINT|CONTEXT|LOCATION):\s+(?:[0-9A-Z]{5}:\s+)?(.*)/;
# t_session_id (%c) can naturaly replace pid as unique session id
# when it is given in log_line_prefix and pid is not present.
$use_sessionid_as_pid = 1 if ( grep(/t_session_id/, @$param_list) && !grep(/t_pid/, @$param_list) );
# Check regex in log line prefix from command line
&check_regex($llp, '--prefix');
return (
'llp' => $llp, 'param_list' => $param_list,
'q_prefix' => $q_prefix, 'q_param_list' => $q_prefix_param
);
}
####
# get_file_size: in scalar context returns the size of the file,
# in list context returns the size of the file and a boolean
# to indicate if the file is compressed.
# The total size returnied is set to -1 when pgbadger can not
# determine the file size (remote file, bzip2 conmpressed file
# and privilege issue). Outside these cases if we can't get size
# of a remote file pgbadger exit with a fatal error.
####
sub get_file_size
{
my $logf = shift;
# Remove log format from log file if any
$logf =~ s/[\r\n]+//sg;
$logf =~ s/:(stderr|csv|syslog|pgbouncer|jsonlog|logplex|rds|redshift)\d*$//i;
my $http_download = ($logf =~ /^(http[s]*:|[s]*ftp:)/i) ? 1 : 0;
my $ssh_download = ($logf =~ /^ssh:/i) ? 1 : 0;
my $iscompressed = ($logf =~ $compress_extensions) ? 1 : 0;
# Get file size
my $totalsize = 0;
# Log entries extracted from journalctl command are of indetermined size
if ( $journalctl_cmd && ($logf =~ m/\Q$journalctl_cmd\E/) )
{
$totalsize = -1;
}
# Log entries extracted from cust command are of indetermined size
elsif ( $log_command && ($logf =~ m/\Q$log_command\E/) )
{
$totalsize = -1;
}
# Same from stdin
elsif ($logf eq '-')
{
$totalsize = -1;
}
# Regular local files can be "stated" if they are not compressed
elsif (!$remote_host && !$http_download && !$ssh_download && !$iscompressed)
{
eval {
$totalsize = (stat($logf))[7];
};
$totalsize = -1 if ($@);
}
# For uncompressed files try to get the size following the remote access protocol
elsif (!$iscompressed)
{
# Use curl to try to get remote file size if it is not compressed
if ($http_download) {
&logmsg('DEBUG', "Looking for file size using command: $curl_command --head \"$logf\" | grep \"Content-Length:\" | awk '{print \$2}'");
$totalsize = `$curl_command --head "$logf" | grep "Content-Length:" | awk '{print \$2}'`;
chomp($totalsize);
localdie("FATAL: can't get size of remote file, please check what's going wrong with command: $curl_command --head \"$logf\" | grep \"Content-Length:\"\n") if ($totalsize eq '');
} elsif ($ssh_download && $logf =~ m#^ssh:\/\/([^\/]+)/(.*)#i) {
my $host_info = $1;
my $file = $2;
$file =~ s/[\r\n]+//sg;
$file =~ s/:(stderr|csv|syslog|pgbouncer|jsonlog|logplex|rds|redshift)\d*$//i;
my $ssh = $ssh_command || 'ssh';
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
my $ssh_command_ls = "\"";
$ssh_command_ls .= "sudo " if ($ssh_sudo);
$ssh_command_ls .= "ls -l '$file'\" | awk '{print \$5}'";
&logmsg('DEBUG', "Looking for file size using command: $ssh $host_info $ssh_command_ls");
$totalsize = `$ssh $host_info $ssh_command_ls`;
chomp($totalsize);
localdie("FATAL: can't get size of remote file, please check what's going wrong with command: $ssh $host_info \"ls -l '$file'\"\n") if ($totalsize eq '');
} elsif ($remote_host) {
my $ssh_command_ls = "\"";
$ssh_command_ls .= "sudo " if ($ssh_sudo);
$ssh_command_ls .= "ls -l '$logf'\" | awk '{print \$5}'";
&logmsg('DEBUG', "Looking for file size using command: $remote_command $ssh_command_ls");
$totalsize = `$remote_command $ssh_command_ls`;
chomp($totalsize);
localdie("FATAL: can't get size of remote file, please check what's going wrong with command: $ssh_command \"ls -l '$logf'\"\n") if ($totalsize eq '');
}
chomp($totalsize);
&logmsg('DEBUG', "Remote file size: $totalsize");
}
# Real size of the file is unknown with compressed file, try to find
# size using uncompress command (bz2 does not report real size)
elsif (!$http_download && $logf =~ $compress_extensions)
{
my $cmd_file_size = $gzip_uncompress_size;
if ($logf =~ /\.zip$/i) {
$cmd_file_size = $zip_uncompress_size;
} elsif ($logf =~ /\.xz$/i) {
$cmd_file_size = $xz_uncompress_size;
} elsif ($logf =~ /\.lz4$/i) {
$cmd_file_size = $lz4_uncompress_size;
} elsif ($logf =~ /\.zst$/i) {
$cmd_file_size = $zstd_uncompress_size;
} elsif ($logf =~ /\.bz2$/i) {
$cmd_file_size = "ls -l '%f' | awk '{print \$5}'";
}
if (!$remote_host && !$http_download && !$ssh_download) {
$cmd_file_size =~ s/\%f/$logf/g;
&logmsg('DEBUG', "Looking for file size using command: $cmd_file_size");
$totalsize = `$cmd_file_size`;
chomp($totalsize);
if ($totalsize !~ /\d+/) {
if ($logf =~ /\.lz4$/i) {
# lz4 archive must be compressed with --content-size option to determine size. If not $totalsize is '-'
&logmsg('DEBUG', "Can't determine lz4 file size. Maybe file compressed without --content-size option ?");
} else {
&logmsg('DEBUG', "Can't determine uncompressed file size. Guess with compressed size * $XZ_FACTOR");
}
# Thus we use a hack to determine size
$cmd_file_size = "ls -l '%f' | awk '{print \$5}'";
$cmd_file_size =~ s/\%f/$logf/g;
$totalsize = `$cmd_file_size`;
$totalsize *= $XZ_FACTOR;
}
} elsif ($ssh_download && $logf =~ m#^ssh://([^\/]+)/(.*)#i) {
my $host_info = $1;
my $file = $2;
my $ssh = $ssh_command || 'ssh';
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
$cmd_file_size =~ s/\%f/$file/g;
$cmd_file_size =~ s/\$/\\\$/g;
&logmsg('DEBUG', "Looking for file size using command: $ssh $host_info \"$cmd_file_size\"");
$totalsize = `$ssh $host_info \"$cmd_file_size\"`;
} else {
$cmd_file_size =~ s/\%f/$logf/g;
$cmd_file_size =~ s/\$/\\\$/g;
&logmsg('DEBUG', "Looking for remote file size using command: $remote_command \"$cmd_file_size\"");
$totalsize = `$remote_command \"$cmd_file_size\"`;
}
chomp($totalsize);
# For bz2 compressed file we don't know the real size
if ($logf =~ /\.bz2$/i) {
# apply deflate estimation factor
$totalsize *= $BZ_FACTOR;
}
}
# Bzip2 and remote download compressed files can't report real size, get compressed
# file size and estimate the real size by using bzip2, gzip and xz factors.
elsif ($http_download)
{
&logmsg('DEBUG', "Looking for file size using command: $curl_command --head \"$logf\" | grep \"Content-Length:\" | awk '{print \$2}'");
$totalsize = `$curl_command --head \"$logf\" | grep "Content-Length:" | awk '{print \$2}'`;
chomp($totalsize);
localdie("FATAL: can't get size of remote file, please check what's going wrong with command: $curl_command --head \"$logf\" | grep \"Content-Length:\"\n") if ($totalsize eq '');
&logmsg('DEBUG', "With http access size real size of a compressed file is unknown but use Content-Length wirth compressed side.");
# For all compressed file we don't know the
# real size apply deflate estimation factor
if ($logf =~ /\.bz2$/i)
{
# apply deflate estimation factor
$totalsize *= $BZ_FACTOR;
}
elsif ($logf =~ /\.(zip|gz)$/i)
{
$totalsize *= $GZ_FACTOR;
}
elsif ($logf =~ /\.(xz|lz4|zst)$/i)
{
$totalsize *= $XZ_FACTOR;
}
}
return $totalsize;
}
sub uncompress_commands
{
my $file = shift();
return if (!$file);
my $uncompress = $zcat;
my $sample_cmd = 'zgrep';
if (($file =~ /\.bz2/i) && ($zcat =~ /^$zcat_cmd$/))
{
$uncompress = $bzcat;
$sample_cmd = 'bzgrep';
} elsif (($file =~ /\.zip/i) && ($zcat =~ /^$zcat_cmd$/)) {
$uncompress = $ucat;
} elsif (($file =~ /\.lz4/i) && ($zcat =~ /^$zcat_cmd$/)) {
$uncompress = $lz4cat;
} elsif (($file =~ /\.zst/i) && ($zcat =~ /^$zcat_cmd$/)) {
$uncompress = $zstdcat;
}
elsif (($file =~ /\.xz/i) && ($zcat =~ /^$zcat_cmd$/))
{
$uncompress = $xzcat;
$sample_cmd = 'xzgrep';
}
return ($uncompress, $sample_cmd);
}
sub get_log_file
{
my ($logf, $totalsize, $sample_only) = @_;
my $lfile = undef;
$LOG_EOL_TYPE = 'LF';
return $lfile if ($totalsize == 0);
$logf =~ s/:(stderr|csv|syslog|pgbouncer|jsonlog|logplex|rds|redshift)\d*$//i;
my $http_download = ($logf =~ /^(http[s]*:|[s]*ftp:)/i) ? 1 : 0;
my $ssh_download = ($logf =~ /^ssh:/i) ? 1 : 0;
my $iscompressed = ($logf =~ $compress_extensions) ? 1 : 0;
chomp($logf);
# Open and return a file handle to parse the log
if ( $journalctl_cmd && ($logf =~ m/\Q$journalctl_cmd\E/) )
{
# For journalctl command we need to use a pipe as file handle
if (!$remote_host) {
open($lfile, '-|', $logf) || localdie("FATAL: cannot read output of command: $logf. $!\n");
}
else
{
if (!$sample_only)
{
&logmsg('DEBUG', "Retrieving log entries using command: $remote_command \"$logf\" |");
# Open a pipe to remote journalctl program
open($lfile, '-|', "$remote_command \"$logf\"") || localdie("FATAL: cannot read from pipe to $remote_command \"$logf\". $!\n");
}
else
{
&logmsg('DEBUG', "Retrieving log entries using command: $remote_command \"'$logf' -n 100\" |");
# Open a pipe to remote journalctl program
open($lfile, '-|', "$remote_command \"'$logf' -n 100\"") || localdie("FATAL: cannot read from pipe to $remote_command \"'$logf' -n 100\". $!\n");
}
}
}
elsif ( $log_command && ($logf =~ m/\Q$log_command\E/) )
{
# For custom command we need to use a pipe as file handle
if (!$remote_host) {
open($lfile, '-|', $logf) || localdie("FATAL: cannot read output of command: $logf. $!\n");
}
else
{
if (!$sample_only)
{
&logmsg('DEBUG', "Retrieving log entries using command: $remote_command \"$logf\" |");
# Open a pipe to remote custom program
open($lfile, '-|', "$remote_command \"$logf\"") || localdie("FATAL: cannot read from pipe to $remote_command \"$logf\". $!\n");
}
else
{
&logmsg('DEBUG', "Retrieving log entries using command: $remote_command \"'$logf' -n 100\" |");
# Open a pipe to remote custom program
open($lfile, '-|', "$remote_command \"'$logf' -n 100\"") || localdie("FATAL: cannot read from pipe to $remote_command \"'$logf' -n 100\". $!\n");
}
}
}
elsif (!$iscompressed)
{
if (!$remote_host && !$http_download && !$ssh_download)
{
if ($logf ne '-')
{
$LOG_EOL_TYPE = &get_eol_type($logf);
open($lfile, '<', $logf) || localdie("FATAL: cannot read log file $logf. $!\n");
}
else
{
$lfile = *STDIN;
}
}
else
{
if (!$sample_only)
{
if (!$http_download)
{
if ($ssh_download && $logf =~ m#^ssh://([^\/]+)/(.*)#i)
{
my $host_info = $1;
my $file = $2;
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
my $ssh = $ssh_command || 'ssh';
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
my $ssh_command_cat = "\"";
$ssh_command_cat .= "sudo " if ($ssh_sudo);
$ssh_command_cat .= "cat '$file'\"";
&logmsg('DEBUG', "Retrieving log entries using command: $ssh $host_info $ssh_command_cat |");
# Open a pipe to cat program
open($lfile, '-|', "$ssh $host_info $ssh_command_cat") || localdie("FATAL: cannot read from pipe to $ssh $host_info $ssh_command_cat. $!\n");
}
else
{
&logmsg('DEBUG', "Retrieving log entries using command: $remote_command \" cat '$logf'\" |");
# Open a pipe to cat program
open($lfile, '-|', "$remote_command \"cat '$logf'\"") || localdie("FATAL: cannot read from pipe to $remote_command \"cat '$logf'\". $!\n");
}
}
else
{
&logmsg('DEBUG', "Retrieving log entries using command: $curl_command --data-binary \"$logf\" |");
# Open a pipe to GET program
open($lfile, '-|', "$curl_command \"$logf\"") || localdie("FATAL: cannot read from pipe to $curl_command --data-binary \"$logf\". $!\n");
}
}
elsif (!$http_download)
{
if ($ssh_download && $logf =~ m#^ssh://([^\/]+)/(.*)#i)
{
my $host_info = $1;
my $file = $2;
my $ssh = $ssh_command || 'ssh';
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
my $ssh_command_tail = "\"";
$ssh_command_tail .= "sudo " if ($ssh_sudo);
$ssh_command_tail .= "tail -n 100 '$file'\"";
&logmsg('DEBUG', "Retrieving log sample using command: $ssh $host_info $ssh_command_tail |");
# Open a pipe to cat program
open($lfile, '-|', "$ssh $host_info $ssh_command_tail") || localdie("FATAL: cannot read from pipe to $remote_command $ssh_command_tail. $!\n");
}
else
{
&logmsg('DEBUG', "Retrieving log sample using command: $remote_command \"tail -n 100 '$logf'\" |");
# Open a pipe to cat program
open($lfile, '-|', "$remote_command \"tail -n 100 '$logf'\"") || localdie("FATAL: cannot read from pipe to $remote_command \"tail -n 100 '$logf'\". $!\n");
}
}
else
{
&logmsg('DEBUG', "Retrieving log sample using command: $curl_command --data-binary --max-filesize 102400 \"$logf\" |");
# Open a pipe to GET program
open($lfile, '-|', "$curl_command --data-binary --max-filesize 102400 \"$logf\"") || localdie("FATAL: cannot read from pipe to $curl_command --data-binary --max-filesize 102400 \"$logf\". $!\n");
}
}
}
else
{
my ($uncompress, $sample_cmd) = &uncompress_commands($logf);
if (!$remote_host && !$http_download && !$ssh_download)
{
&logmsg('DEBUG', "Compressed log file, will use command: $uncompress \"$logf\"");
# Open a pipe to zcat program for compressed log
open($lfile, '-|', "$uncompress \"$logf\"") || localdie("FATAL: cannot read from pipe to $uncompress \"$logf\". $!\n");
}
else
{
if (!$sample_only)
{
if (!$http_download)
{
if ($ssh_download && $logf =~ m#^ssh://([^\/]+)/(.*)#i)
{
my $host_info = $1;
my $file = $2;
my $ssh = $ssh_command || 'ssh';
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
&logmsg('DEBUG', "Compressed log file, will use command: $ssh $host_info \"$uncompress '$file'\"");
# Open a pipe to zcat program for compressed log
open($lfile, '-|', "$ssh $host_info \"$uncompress '$file'\"") || localdie("FATAL: cannot read from pipe to $remote_command \"$uncompress '$logf'\". $!\n");
}
else
{
&logmsg('DEBUG', "Compressed log file, will use command: $remote_command \"$uncompress '$logf'\"");
# Open a pipe to zcat program for compressed log
open($lfile, '-|', "$remote_command \"$uncompress '$logf'\"") || localdie("FATAL: cannot read from pipe to $remote_command \"$uncompress '$logf'\". $!\n");
}
}
else
{
&logmsg('DEBUG', "Retrieving log entries using command: $curl_command \"$logf\" | $uncompress |");
# Open a pipe to GET program
open($lfile, '-|', "$curl_command \"$logf\" | $uncompress") || localdie("FATAL: cannot read from pipe to $curl_command \"$logf\". $!\n");
}
}
elsif (!$http_download)
{
if ($ssh_download && $logf =~ m#^ssh://([^\/]+)/(.*)#i)
{
my $host_info = $1;
my $file = $2;
my $ssh = $ssh_command || 'ssh';
if ($host_info =~ s/:(\d+)$//) {
$host_info = "-p $1 $host_info";
}
$ssh .= " -i $ssh_identity" if ($ssh_identity);
$ssh .= " $ssh_options" if ($ssh_options);
&logmsg('DEBUG', "Compressed log file, will use command: $ssh $host_info \"$uncompress '$file'\"");
# Open a pipe to zcat program for compressed log
open($lfile, '-|', "$ssh $host_info \"$sample_cmd -m 100 '[1234567890]' '$file'\"") || localdie("FATAL: cannot read from pipe to $ssh $host_info \"$sample_cmd -m 100 '' '$file'\". $!\n");
}
else
{
&logmsg('DEBUG', "Compressed log file, will use command: $remote_command \"$uncompress '$logf'\"");
# Open a pipe to zcat program for compressed log
open($lfile, '-|', "$remote_command \"$sample_cmd -m 100 '[1234567890]' '$logf'\"") || localdie("FATAL: cannot read from pipe to $remote_command \"$sample_cmd -m 100 '' '$logf'\". $!\n");
}
}
else
{
# Open a pipe to GET program
open($lfile, '-|', "$curl_command --max-filesize 102400 \"$logf\" | $uncompress") || localdie("FATAL: cannot read from pipe to $curl_command --max-filesize 102400 \"$logf\" | $uncompress . $!\n");
}
}
}
return $lfile;
}
sub split_logfile
{
my $logf = shift;
my $totalsize = shift;
my $saved_pos = shift;
# CSV file can't be parsed using multiprocessing
return (0, -1) if ( $format eq 'csv' );
# Do not split the file if we don't know his size
return (0, -1) if ($totalsize <= 0);
my @chunks = (0);
# Seek to the last saved position
if ($last_parsed && $saved_pos) {
if ($saved_pos < $totalsize) {
$chunks[0] = $saved_pos;
}
}
# With small files < 16MB splitting is inefficient
if ($totalsize <= 16777216) {
return ($chunks[0], $totalsize);
}
my $i = 1;
my $lfile = &get_log_file($logf, $totalsize); # Get file handle to the file
if (defined $lfile)
{
while ($i < $queue_size)
{
my $pos = int(($totalsize/$queue_size) * $i);
if ($pos > $chunks[0])
{
$lfile->seek($pos, 0);
# Move the offset to the BEGINNING of each line, because
# the logic in process_file requires so
$pos= $pos + length(<$lfile>) - 1;
push(@chunks, $pos) if ($pos < $totalsize);
}
last if ($pos >= $totalsize);
$i++;
}
$lfile->close();
}
push(@chunks, $totalsize);
return @chunks;
}
# Return the week number of the year for a given date
sub get_week_number
{
my ($year, $month, $day) = @_;
# %U The week number of the current year as a decimal number, range 00 to 53, starting with the first
# Sunday as the first day of week 01.
# %V The ISO 8601 week number (see NOTES) of the current year as a decimal number, range 01 to 53,
# where week 1 is the first week that has at least 4 days in the new year.
# %W The week number of the current year as a decimal number, range 00 to 53, starting with the first
# Monday as the first day of week 01.
# Check if the date is valid first
my $datefmt = POSIX::strftime("%Y-%m-%d", 1, 1, 1, $day, $month - 1, $year - 1900);
if ($datefmt ne "$year-$month-$day") {
return -1;
}
my $weekNumber = '';
if (!$iso_week_number)
{
if (!$week_start_monday) {
$weekNumber = POSIX::strftime("%U", 1, 1, 1, $day, $month - 1, $year - 1900);
} else {
$weekNumber = POSIX::strftime("%W", 1, 1, 1, $day, $month - 1, $year - 1900);
}
}
else
{
$weekNumber = POSIX::strftime("%V", 1, 1, 1, $day, $month - 1, $year - 1900);
}
return sprintf("%02d", (!$iso_week_number) ? $weekNumber+1 : $weekNumber);
}
# Returns day number of the week of a given days
sub get_day_of_week
{
my ($year, $month, $day) = @_;
# %w The day of the week as a decimal, range 0 to 6, Sunday being 0.
my $weekDay = '';
if (!$week_start_monday && !$iso_week_number) {
# Start on sunday = 0
$weekDay = POSIX::strftime("%w", 1,1,1,$day,--$month,$year-1900);
} else {
# Start on monday = 1
$weekDay = POSIX::strftime("%w", 1,1,1,$day,--$month,$year-1900);
$weekDay = (($weekDay+7)-1) % 7;
}
return $weekDay;
}
# Returns all days following the week number
sub get_wdays_per_month
{
my $wn = shift;
my ($year, $month) = split(/\-/, shift);
my @months = ();
my @retdays = ();
$month ||= '01';
push(@months, "$year$month");
my $start_month = $month;
if ($month eq '01') {
unshift(@months, ($year - 1) . "12");
} else {
unshift(@months, $year . sprintf("%02d", $month - 1));
}
if ($month == 12) {
push(@months, ($year+1) . "01");
} else {
push(@months, $year . sprintf("%02d", $month + 1));
}
foreach my $d (@months)
{
$d =~ /^(\d{4})(\d{2})$/;
my $y = $1;
my $m = $2;
foreach my $day ("01" .. "31")
{
# Check if the date is valid first
my $datefmt = POSIX::strftime("%Y-%m-%d", 1, 1, 1, $day, $m - 1, $y - 1900);
if ($datefmt ne "$y-$m-$day") {
next;
}
my $weekNumber = '';
if (!$iso_week_number)
{
if (!$week_start_monday) {
$weekNumber = POSIX::strftime("%U", 1, 1, 1, $day, $m - 1, $y - 1900);
} else {
$weekNumber = POSIX::strftime("%W", 1, 1, 1, $day, $m - 1, $y - 1900);
}
}
else
{
$weekNumber = POSIX::strftime("%V", 1, 1, 1, $day, $m - 1, $y - 1900);
}
if (!$iso_week_number)
{
if ( ($weekNumber == $wn) || ( ($weekNumber eq '00') && (($wn == 1) || ($wn >= 52)) ) )
{
push(@retdays, "$year-$m-$day");
return @retdays if ($#retdays == 6);
}
}
else
{
if ( ($weekNumber == $wn) || ( ($weekNumber eq '01') && (($wn == 1) || ($wn >= 53)) ) )
{
push(@retdays, "$year-$m-$day");
return @retdays if ($#retdays == 6);
}
}
next if ($weekNumber > $wn);
}
}
return @retdays;
}
sub IsLeapYear
{
return ((($_[0] & 3) == 0) && (($_[0] % 100 != 0) || ($_[0] % 400 == 0)));
}
####
# Display calendar
####
sub get_calendar
{
my ($curdb, $year, $month) = @_;
my $str = "
\n";
my @wday = qw(Su Mo Tu We Th Fr Sa);
my @std_day = qw(Su Mo Tu We Th Fr Sa);
if ($week_start_monday || $iso_week_number) {
@wday = qw(Mo Tu We Th Fr Sa Su);
@std_day = qw(Mo Tu We Th Fr Sa Su);
}
my %day_lbl = ();
for (my $i = 0; $i <= $#wday; $i++) {
$day_lbl{$wday[$i]} = $wday[$i];
}
$str .= "
";
map { $str .= '
' . $day_lbl{$_} . '
'; } @wday;
$str .= "
\n\n";
my @currow = ('','','','','','','');
my $wd = 0;
my $wn = 0;
my $week = '';
my $dest_dir = $html_outdir || $outdir;
my $tmp_dir = "$dest_dir/$curdb";
$tmp_dir = $dest_dir if (!$report_per_database);
for my $d ("01" .. "31") {
last if (($d == 31) && grep(/^$month$/, '04','06','09','11'));
last if (($d == 30) && ($month eq '02'));
last if (($d == 29) && ($month eq '02') && !&IsLeapYear($year));
$wd = &get_day_of_week($year,$month,$d);
$wn = &get_week_number($year,$month,$d);
next if ($wn == -1);
if ( !-e "$tmp_dir/$year/$month/$d/index.html" ) {
$currow[$wd] = "
};
}
sub _gethostbyaddr
{
my $ip = shift;
my $host = undef;
unless(exists $CACHE_DNS{$ip}) {
eval {
local $SIG{ALRM} = sub { die "DNS lookup timeout.\n"; };
alarm($DNSLookupTimeout);
$host = gethostbyaddr(inet_aton($ip), AF_INET);
alarm(0);
};
if ($@) {
$CACHE_DNS{$ip} = undef;
#printf "_gethostbyaddr timeout : %s\n", $ip;
}
else {
$CACHE_DNS{$ip} = $host;
#printf "_gethostbyaddr success : %s (%s)\n", $ip, $host;
}
}
return $CACHE_DNS{$ip} || $ip;
}
sub localdie
{
my ($msg, $code) = @_;
my ($package, $filename, $line) = caller;
print STDERR "$msg - Error at line $line\n";
unlink("$PID_FILE");
exit($code || 1);
}
####
# Skip unwanted lines
# Return 1 when the line must be excluded
# Return 1 if we are after the end timestamp
# Return 0 if this is a wanted line
####
sub skip_unwanted_line
{
# do not report lines which are not at the specific times
if ($#exclude_time >= 0)
{
my $found = 0;
foreach (@exclude_time)
{
if ($prefix_vars{'t_timestamp'} =~ /$_/)
{
$found = 1;
last;
}
}
return 1 if ($found);
}
# Only reports lines that are at the specific times
if ($#include_time >= 0)
{
my $found = 0;
foreach (@include_time)
{
if ($prefix_vars{'t_timestamp'} !~ /$_/)
{
$found = 1;
last;
}
}
return 1 if ( $found );
}
# check begin or end time without the date
# and extract the hour here, late, to get the timezone
# already applied
if ( $from_hour || $to_hour )
{
return 1 if ( $from_hour && ( $from_hour gt $prefix_vars{'t_time'} ) );
return 1 if ( $to_hour && ( $to_hour lt $prefix_vars{'t_time'} ) );
}
else
{
# check against date/timestamp
return 1 if ($from && ($from gt $prefix_vars{'t_timestamp'}));
return -1 if ($to && ($to lt $prefix_vars{'t_timestamp'}));
}
return 0;
}
sub change_timezone
{
my ($y, $mo, $d, $h, $mi, $s) = @_;
my $t = timegm_nocheck($s, $mi, $h, $d, $mo-1, $y-1900);
$t += $log_timezone;
($s, $mi, $h, $d, $mo, $y) = gmtime($t);
return ($y+1900, sprintf("%02d", ++$mo), sprintf("%02d", $d), sprintf("%02d", $h), sprintf("%02d", $mi), sprintf("%02d", $s));
}
# Set the default extension and output format, load JSON Perl podule if required
# Force text output with normalized query list only and disable incremental report
# Set default filename of the output file
sub set_output_extension
{
my ($od, $of, $ext, $db) = @_;
if (!$ext)
{
if ($of =~ /\.bin/i)
{
$ext = 'binary';
}
elsif ($of =~ /\.json/i)
{
if (eval {require JSON::XS;1;} ne 1)
{
localdie("Can not save output in json format, please install Perl module JSON::XS first.\n");
}
else
{
JSON::XS->import();
}
$ext = 'json';
}
elsif ($of =~ /\.htm[l]*/i)
{
$ext = 'html';
}
elsif ($of)
{
$ext = 'txt';
}
else
{
$ext = 'html';
}
}
elsif (lc($ext) eq 'json')
{
if (eval {require JSON::XS;1;} ne 1)
{
localdie("Can not save output in json format, please install Perl module JSON::XS first.\n");
}
else
{
JSON::XS->import();
}
}
if ($dump_normalized_only || $dump_all_queries)
{
$ext = 'txt';
$incremental = 0;
$report_title = 'Normalized query report' if (!$report_title && !$dump_all_queries);
}
$of ||= 'out.' . $ext;
# Append the current database name to the output file.
$of = $db . '_' . $of if ($db && $report_per_database && $db ne $DBALL && $of ne '-');
# Add the destination directory
$of = $od . '/' . $of if ($od && $of !~ m#^\Q$od\E# && $of ne '-');
&logmsg('DEBUG', "Output '$ext' reports will be written to $of") if (!$rebuild && !$report_per_database);
return ($of, $ext);
}
# Set timezone
sub set_timezone
{
my $init = shift;
$timezone = ((0-$opt_timezone)*3600);
$log_timezone = ((0-$opt_log_timezone)*3600);
return if ($init);
if (!$timezone && !$isUTC) {
my @lt = localtime();
# count TimeZone and Daylight Saving Time
$timezone = timelocal(@lt) - timegm(@lt);
&logmsg('DEBUG', "timezone not specified, using $timezone seconds" );
}
}
sub maxlen_truncate
{
if ($maxlength && length($_[0]) > $maxlength)
{
$_[0] = substr($_[0], 0, $maxlength);
$_[0] =~ s/((?:[,\(=\~]|LIKE)\s*'[^']*)$/$1'/is if ($anonymize);
$_[0] .= '[...]';
}
}
# return 1 or 2 following the EOL type (CR, LF or CRLF)
sub get_eol_length
{
return length($LOG_EOL_TYPE)/2;
}
####
# Return the type of EOL of a file: Mac (CR), Windows (CRLF), Linux (LF)
# Assume LF by default
####
sub get_eol_type
{
my $file = shift;
if (open(my $in, '<', $file))
{
binmode($in); ## (added as an update)
my ( $cr, $lf, $crlf ) = ( 0 ) x 3;
my $c = '';
while ( read($in, $c, 65536, 1) )
{
$lf += $c=~ tr/\x0A/\x0A/;
$cr += $c =~ tr/\x0D/\x0D/;
$crlf += $c =~ s/\x0D\x0A/xx/g ;
$c = chop;
$cr-- if ( $c eq "\x0D" ); # a final CR or LF will get counted
$lf-- if ( $c eq "\x0A" ); # again on the next iteration
}
close($in);
$cr++ if ( $c eq "\x0D" );
$lf++ if ( $c eq "\x0A" );
if ($lf && !$cr) {
return 'LF';
} elsif ($cr && !$lf) {
return 'CR';
} elsif ($crlf) {
return 'CRLF';
}
}
else
{
print "WARNING: can't read file $file, $!\n";
}
return 'LF';
}
sub html_escape
{
my $toencode = shift;
return undef unless defined($toencode);
utf8::encode($toencode) if utf8::is_utf8($toencode);
$toencode=~s/([^a-zA-Z0-9_.~-])/uc sprintf("%%%02x",ord($1))/eg;
return $toencode;
}
sub dump_raw_csv
{
my $t_pid = shift;
my $sep = ';';
if ($csv_sep_char) {
$sep = $csv_sep_char;
}
# CSV columns information:
# ------------------------
# timestamp without milliseconds
# username
# database name
# Process id
# Remote host
# session id
# Error severity
# SQL state code
# Query duration
# user query / error message
# bind parameters
# application name
# backend type
# query id
print "timestamp${sep}username${sep}dbname${sep}pid${sep}client${sep}sessionid${sep}loglevel${sep}sqlstate${sep}duration${sep}query/error${sep}parameters${sep}appname${sep}backendtype${sep}queryid\n" if (!$header_done);
$header_done = 1;
print "$cur_info{$t_pid}{timestamp}$cur_info{$t_pid}{ms}${sep}$cur_info{$t_pid}{dbuser}${sep}$cur_info{$t_pid}{dbname}${sep}";
print "$cur_info{$t_pid}{pid}${sep}$cur_info{$t_pid}{dbclient}${sep}$cur_info{$t_pid}{session}${sep}";
print "$cur_info{$t_pid}{loglevel}${sep}$cur_info{$t_pid}{sqlstate}${sep}$cur_info{$t_pid}{duration}${sep}";
my $query = ($cur_info{$t_pid}{query} || $cur_lock_info{$t_pid}{query} || $cur_temp_info{$t_pid}{query}
|| $cur_cancel_info{$t_pid}{query} || "plan:\n" .$cur_plan_info{$t_pid}{plan});
$query =~ s/[\r\n]/\\n/gs;
if ($query =~ /${sep}/) {
$query =~ s/"/""/g;
$query = '"' . $query . '"';
}
print $query . "${sep}";
($cur_info{$t_pid}{parameters}) ? print "\"$cur_info{$t_pid}{parameters}\"${sep}" : print "${sep}";
($cur_info{$t_pid}{dbappname}) ? print "\"$cur_info{$t_pid}{dbappname}\"${sep}" : print "${sep}";
print "$cur_info{$t_pid}{backendtype}${sep}$cur_info{$t_pid}{queryid}\n";
}
# Inclusion of Perl package pgFormatter::Beautify.
{
package pgFormatter::Beautify;
use strict;
use warnings;
use warnings qw( FATAL );
use Encode qw( decode );
use utf8;
binmode STDIN, ':utf8';
binmode STDOUT, ':utf8';
binmode STDERR, ':utf8';
use Text::Wrap;
our $DEBUG = 0;
our $DEBUG_SP = 0;
# PostgreSQL functions that use a FROM clause
our @have_from_clause = qw( extract overlay substring trim );
our @extract_keywords = qw(century day decade dow doy epoch hour isodow isoyear microseconds millennium minute month quarter second timezone timezone_minute week year);
our $math_operators = qr{^(?:\+|\-|\*|\/|\%|\^|\|\/|\|\|\/|\!|\!\!|\@|\&|\||\#|\~|<<|>>|=|>=|<=)$};
=head1 NAME
pgFormatter::Beautify - Library for pretty-printing SQL queries
=head1 VERSION
Version 5.9
=cut
# Version of pgFormatter
our $VERSION = '5.9';
# Inclusion of code from Perl package SQL::Beautify
# Copyright (C) 2009 by Jonas Kramer
# Published under the terms of the Artistic License 2.0.
=head1 SYNOPSIS
This module can be used to reformat given SQL query, optionally anonymizing parameters.
Output can be either plain text, or it can be HTML with appropriate styles so that it can be displayed on a web page.
Example usage:
my $beautifier = pgFormatter::Beautify->new();
$beautifier->query( 'select a,b,c from d where e = f' );
$beautifier->beautify();
my $nice_txt = $beautifier->content();
$beautifier->format('html');
$beautifier->beautify();
my $nice_html = $beautifier->content();
$beautifier->format('html');
$beautifier->anonymize();
$beautifier->beautify();
my $nice_anonymized_html = $beautifier->content();
$beautifier->format();
$beautifier->beautify();
$beautifier->wrap_lines()
my $wrapped_txt = $beautifier->content();
=head1 FUNCTIONS
=head2 new
Generic constructor - creates object, sets defaults, and reads config from given hash with options.
Takes options as hash. Following options are recognized:
=over
=item * break - String that is used for linebreaks. Default is "\n".
=item * colorize - if set to false CSS style will not be applied to html output. Used internally to display errors in CGI mode withour style.
=item * comma - set comma at beginning or end of a line in a parameter list
=over
=item end - put comma at end of the list (default)
=item start - put comma at beginning of the list
=back
=item * comma_break - add new-line after each comma in INSERT statements
=item * format - set beautify format to apply to the content (default: text)
=over
=item text - output content as plain/text (command line mode default)
=item html - output text/html with CSS style applied to content (CGI mode default)
=back
=item * functions - list (arrayref) of strings that are function names
=item * keywords - list (arrayref) of strings that are keywords
=item * multiline - use multi-line search for placeholder regex, see placeholder.
=item * no_comments - if set to true comments will be removed from query
=item * no_grouping - if set to true statements will not be grouped in a transaction, an extra newline character will be added between statements like outside a transaction.
=item * placeholder - use the specified regex to find code that must not be changed in the query.
=item * query - query to beautify
=item * rules - hash of rules - uses rule semantics from SQL::Beautify
=item * space - character(s) to be used as space for indentation
=item * spaces - how many spaces to use for indentation
=item * uc_functions - what to do with function names:
=over
=item 0 - do not change
=item 1 - change to lower case
=item 2 - change to upper case
=item 3 - change to Capitalized
=back
=item * separator - string used as dynamic code separator, default is single quote
=item * uc_keywords - what to do with keywords - meaning of value like with uc_functions
=item * uc_types - what to do with data types - meaning of value like with uc_functions
=item * wrap - wraps given keywords in pre- and post- markup. Specific docs in SQL::Beautify
=item * format_type - try an other formatting
=item * wrap_limit - wrap queries at a certain length
=item * wrap_after - number of column after which lists must be wrapped
=item * wrap_comment - apply wrapping to comments starting with --
=item * numbering - statement numbering as a comment before each query
=item * redshift - add Redshift keywords (obsolete, use --extra-keyword)
=item * no_extra_line - do not add an extra empty line at end of the output
=item * keep_newline - preserve empty line in plpgsql code
=item * no_space_function - remove space before function call and open parenthesis
=item * redundant_parenthesis - do not eliminate redundant parenthesis in DML queries
=back
For defaults, please check function L.
=cut
sub new {
my $class = shift;
my %options = @_;
our @have_from_clause = qw( extract overlay substring trim );
our @extract_keywords = qw(century day decade dow doy epoch hour isodow isoyear microseconds millennium minute month quarter second timezone timezone_minute week year);
our $math_operators = qr{^(?:\+|\-|\*|\/|\%|\^|\|\/|\|\|\/|\!|\!\!|\@|\&|\||\#|\~|<<|>>|=|>=|<=)$};
my $self = bless {}, $class;
$self->set_defaults();
for my $key (
qw( query spaces space break wrap keywords functions rules uc_keywords uc_functions uc_types no_comments no_grouping placeholder multiline separator comma comma_break format colorize format_type wrap_limit wrap_after wrap_comment numbering redshift no_extra_line keep_newline no_space_function redundant_parenthesis)
)
{
$self->{$key} = $options{$key} if defined $options{$key};
}
$self->_refresh_functions_re();
# Make sure "break" is sensible
$self->{'break'} = ' ' if $self->{'spaces'} == 0;
# Initialize internal stuff.
$self->{'_level'} = 0;
# Array to store placeholders values
@{ $self->{'placeholder_values'} } = ();
# Hash to store dynamic code
%{ $self->{'dynamic_code'} } = ();
# Hash to store and preserve constants
%{ $self->{'keyword_constant'} } = ();
# Hash to store and preserve aliases between double quote
%{ $self->{'alias_constant'} } = ();
# Check comma value, when invalid set to default: end
if ( lc( $self->{'comma'} ) ne 'start' ) {
$self->{'comma'} = 'end';
}
else {
$self->{'comma'} = lc( $self->{'comma'} );
}
$self->{'format'} //= 'text';
$self->{'colorize'} //= 1;
$self->{'format_type'} //= 0;
$self->{'wrap_limit'} //= 0;
$self->{'wrap_after'} //= 0;
$self->{'wrap_comment'} //= 0;
$self->{'no_extra_line'} //= 0;
return $self;
}
=head2 query
Accessor to query string. Both reads:
$object->query()
, and writes
$object->query( $something )
=cut
sub query {
my $self = shift;
my $new_value = shift;
$self->{'query'} = $new_value if defined $new_value;
$self->{idx_code} = 0;
# Replace any COMMENT constant between single quote
while ( $self->{'query'} =~
s/IS\s+([EU]*'(?:[^;]*)')\s*;/IS TEXTVALUE$self->{idx_code};/is )
{
$self->{dynamic_code}{ $self->{idx_code} } = $1;
$self->{dynamic_code}{ $self->{idx_code} } =~
s/([\n\r])\s+([EU]*'(?:[^']*)')/$1 . ($self->{ 'space' } x $self->{ 'spaces' }) . $2/gsei;
$self->{idx_code}++;
}
# Replace any \\ by BSLHPGF
$self->{'query'} =~ s/\\\\/BSLHPGF/sg;
# Replace any \' by PGFBSLHQ
$self->{'query'} =~ s/\\'/PGFBSLHQ/sg;
# Replace any '' by PGFESCQ1
while ( $self->{'query'} =~ s/([^'])''([^'])/$1PGFESCQ1$2/s ) { }
# Replace any '''' by PGFESCQ1PGFESCQ1
while ( $self->{'query'} =~ s/([^'])''''([^'])/$1PGFESCQ1PGFESCQ1$2/s ) { }
# Replace any '...''' by '.*PGFESCQ1'
while ( $self->{'query'} =~ s/([^']'[^']+)''('[^'])/$1PGFESCQ1$2/s ) { }
# Replace any '''...' by 'PGFESCQ1.*'
while ( $self->{'query'} =~ s/([^']')''([^']+'[^'])/$1PGFESCQ1$2/s ) { }
# Replace any multiline '''...''' by 'PGFESCQ1...PGFESCQ1'
$self->{'query'} =~ s/([^']')''([^']*)''('[^']|$)/$1PGFESCQ1$2PGFESCQ1$3/sg;
# Replace any "" by PGFESCQ2
while ( $self->{'query'} =~ s/([^"])""([^"])/$1PGFESCQ2$2/s ) { }
# Replace aliases using double quote
my $j = 0;
while ( $self->{'query'} =~ s/(\s+AS\s*)("+[^"]+"+)/$1PGFALIAS$j/is ) {
$self->{'alias_constant'}{$j} = $2;
$j++;
}
# Escape quote in comments
while ( $self->{'query'} =~ s/(\/\*(?:.*)?)'((?:.*)?\*\/)/$1SNGLQUOTE$2/s )
{
}
# replace all constant between quote
$j = 0;
while ( $self->{'query'} =~ s/('[^'\n\r]+')/AAKEYWCONST${j}AA/s ) {
$self->{'keyword_constant'}{$j} = $1;
$j++;
}
# Restore quote in comments
$self->{'query'} =~ s/SNGLQUOTE/'/gs;
foreach my $k ( keys %{ $self->{'keyword_constant'} } ) {
$self->{'keyword_constant'}{$k} =~ s/SNGLQUOTE/'/gs;
}
# Fix false positive generated by code above.
while ( $self->{'query'} =~
s/(\s+AS\s+)AAKEYWCONST(\d+)AA/$1$self->{ 'keyword_constant' }{$2}/is )
{
delete $self->{'keyword_constant'}{$2};
}
# Hide content of format() function when the code separator is not a single quote */
my $i = 0;
while ( $self->{'query'} =~
s/\bformat\((\$(?:.*)?\$\s*)([,\)])/format\(CODEPARTB${i}CODEPARTB$2/i )
{
push( @{ $self->{'placeholder_values'} }, $1 );
$i++;
}
my %temp_placeholder = ();
my @temp_content =
split( /(CREATE(?:\s+OR\s+REPLACE)?\s+(?:FUNCTION|PROCEDURE)\s+)/i,
$self->{'query'} );
if ( $#temp_content > 0 ) {
for ( my $j = 0 ; $j <= $#temp_content ; $j++ ) {
next
if ( $temp_content[$j] =~ /^CREATE/i or $temp_content[$j] eq '' );
# Replace single quote code delimiter into $PGFDLM$
if ( $temp_content[$j] !~
s/(\s+AS\s+)'(\s+.*?;\s*)'/$1\$PGFDLM\$$2\$PGFDLM\$/is )
{
$temp_content[$j] =~
s/(\s+AS\s+)'(\s+.*?END[;]*\s*)'/$1\$PGFDLM\$$2\$PGFDLM\$/is;
}
# Remove any call too CREATE/DROP LANGUAGE to not break search of function code separator
$temp_content[$j] =~ s/(CREATE|DROP)\s+LANGUAGE\s+[^;]+;.*//is;
# Fix case where code separator with $ is associated to begin/end keywords
$temp_content[$j] =~ s/([^\s]+\$)(BEGIN\s)/$1 $2/igs;
$temp_content[$j] =~ s/(\sEND)(\$[^\s]+)/$1 $2/igs;
$temp_content[$j] =~ s/(CREATE|DROP)\s+LANGUAGE\s+[^;]+;.*//is;
my $fctname = '';
if ( $temp_content[$j] =~ /^([^\s\(]+)/ ) {
$fctname = lc($1);
}
next if ( !$fctname );
my $language = 'sql';
if ( $temp_content[$j] =~ /\s+LANGUAGE\s+[']*([^'\s;]+)[']*/is ) {
$language = lc($1);
if ( $language =~ /AAKEYWCONST(\d+)AA/i ) {
$language = lc( $self->{'keyword_constant'}{$1} );
$language =~ s/'//g;
}
}
if ( $language =~ /^internal$/i ) {
if ( $temp_content[$j] =~
s/AS ('[^\']+')/AS CODEPARTB${i}CODEPARTB/is )
{
push( @{ $self->{'placeholder_values'} }, $1 );
$i++;
}
}
# C function language with AS obj_file, link_symbol
elsif ( $language =~ /^c$/i ) {
if ( $temp_content[$j] =~
s/AS ('[^\']+')\s*,\s*('[^\']+')/AS CODEPARTB${i}CODEPARTB/is
)
{
push( @{ $self->{'placeholder_values'} }, "$1, $2" );
$i++;
}
}
# if the function language is not SQL or PLPGSQL
elsif ( $language !~ /^(?:plpg)?sql$/ ) {
# Try to find the code separator
my $tmp_str = $temp_content[$j];
while ( $tmp_str =~ s/\s+AS\s+([^\s]+)\s+//is ) {
my $code_sep = quotemeta($1);
foreach my $k ( @{ $self->{'keywords'} } ) {
last if ( $code_sep =~ s/\b$k$//i );
}
next if ( !$code_sep );
if ( $tmp_str =~ /\s+$code_sep[\s;]+/ ) {
while ( $temp_content[$j] =~
s/($code_sep(?:.+?)$code_sep)/CODEPART${i}CODEPART/s
)
{
push( @{ $self->{'placeholder_values'} }, $1 );
$i++;
}
last;
}
}
}
}
}
$self->{'query'} = join( '', @temp_content );
# Store values of code that must not be changed following the given placeholder
if ( $self->{'placeholder'} ) {
if ( !$self->{'multiline'} ) {
while ( $self->{'query'} =~
s/($self->{ 'placeholder' })/PLACEHOLDER${i}PLACEHOLDER/ )
{
push( @{ $self->{'placeholder_values'} }, $1 );
$i++;
}
}
else {
while ( $self->{'query'} =~
s/($self->{ 'placeholder' })/PLACEHOLDER${i}PLACEHOLDER/s )
{
push( @{ $self->{'placeholder_values'} }, $1 );
$i++;
}
}
}
# Replace dynamic code with placeholder
$self->_remove_dynamic_code( \$self->{'query'}, $self->{'separator'} );
# Replace operator with placeholder
$self->_quote_operator( \$self->{'query'} );
# Replace comment with not quote delimiter with placeholder
$self->_quote_comment_stmt( \$self->{'query'} );
return $self->{'query'};
}
=head2 content
Accessor to content of results. Must be called after $object->beautify().
This can be either plain text or html following the format asked by the
client with the $object->format() method.
=cut
sub content {
my $self = shift;
my $new_value = shift;
$self->{'content'} = $new_value if defined $new_value;
$self->{'content'} =~ s/\(\s+\(/\(\(/gs;
# Replace placeholders with their original dynamic code
$self->_restore_dynamic_code( \$self->{'content'} );
# Replace placeholders with their original operator
$self->_restore_operator( \$self->{'content'} );
# Replace placeholders with their original string
$self->_restore_comment_stmt( \$self->{'content'} );
# Replace placeholders by their original values
if ( $#{ $self->{'placeholder_values'} } >= 0 ) {
$self->{'content'} =~
s/PLACEHOLDER(\d+)PLACEHOLDER/$self->{ 'placeholder_values' }[$1]/igs;
$self->{'content'} =~
s/CODEPART[B]*(\d+)CODEPART[B]*/$self->{ 'placeholder_values' }[$1]/igs;
}
$self->{'content'} =~ s/PGFALIAS(\d+)/$self->{ 'alias_constant' }{$1}/gs;
while ( $self->{'content'} =~
s/AAKEYWCONST(\d+)AA/$self->{ 'keyword_constant' }{$1}/s )
{
delete $self->{'keyword_constant'}{$1};
}
# Replace any BSLHPGF by \\
$self->{'content'} =~ s/BSLHPGF/\\\\/g;
# Replace any PGFBSLHQ by \'
$self->{'content'} =~ s/PGFBSLHQ/\\'/g;
# Replace any $PGFDLM$ by code delimiter '
$self->{'content'} =~ s/\$PGFDLM\$/'/g;
# Replace any PGFESCQ1 by ''
$self->{'content'} =~ s/PGFESCQ1/''/g;
# Replace any PGFESCQ2 by ""
$self->{'content'} =~ s/PGFESCQ2/""/g;
return $self->{'content'};
}
=head2 highlight_code
Makes result html with styles set for highlighting.
=cut
sub highlight_code {
my ( $self, $token, $last_token, $next_token ) = @_;
# Do not use uninitialized variable
$last_token //= '';
$next_token //= '';
# Colorize operators
while ( my ( $k, $v ) = each %{ $self->{'dict'}->{'symbols'} } ) {
if ( $token eq $k ) {
$token = '' . $v . '';
return $token;
}
}
# lowercase/uppercase keywords taking care of function with same name
if (
$self->_is_keyword( $token, $next_token, $last_token )
&& ( !$self->_is_function( $token, $last_token, $next_token )
|| $next_token ne '(' )
)
{
if ( $self->{'uc_keywords'} == 1 ) {
$token = '' . $token . '';
}
elsif ( $self->{'uc_keywords'} == 2 ) {
$token = '' . $token . '';
}
elsif ( $self->{'uc_keywords'} == 3 ) {
$token = '' . $token . '';
}
else {
$token = '' . $token . '';
}
return $token;
}
# lowercase/uppercase known functions or words followed by an open parenthesis
# if the token is not a keyword, an open parenthesis or a comment
if (
(
$self->_is_function( $token, $last_token, $next_token )
&& $next_token eq '('
)
|| ( not $self->_is_keyword( $token, $next_token, $last_token )
&& $next_token ne '('
&& $token ne '('
&& not $self->_is_comment($token) )
)
{
if ( $self->{'uc_functions'} == 1 ) {
$token = '' . $token . '';
}
elsif ( $self->{'uc_functions'} == 2 ) {
$token = '' . $token . '';
}
elsif ( $self->{'uc_functions'} == 3 ) {
$token = '' . $token . '';
}
else {
$token = '' . $token . '';
}
return $token;
}
# Colorize STDIN/STDOUT in COPY statement
if ( grep( /^\Q$token\E$/i, @{ $self->{'dict'}->{'copy_keywords'} } ) ) {
if ( $self->{'uc_keywords'} == 1 ) {
$token = '' . $token . '';
}
elsif ( $self->{'uc_keywords'} == 2 ) {
$token = '' . $token . '';
}
elsif ( $self->{'uc_keywords'} == 3 ) {
$token = '' . $token . '';
}
else {
$token = '' . $token . '';
}
return $token;
}
# Colorize parenthesis
if ( grep( /^\Q$token\E$/i, @{ $self->{'dict'}->{'brackets'} } ) ) {
$token = '' . $token . '';
return $token;
}
# Colorize comment
if ( $self->_is_comment($token) ) {
$token = '' . $token . '';
return $token;
}
# Colorize numbers
$token =~ s/\b(\d+)\b/$1<\/span>/igs;
# Colorize string
$token =~ s/('.*?(?$1<\/span>/gs;
$token =~ s/(`[^`]*`)/$1<\/span>/gs;
return $token;
}
=head2 tokenize_sql
Splits input SQL into tokens
Code lifted from SQL::Beautify
=cut
sub tokenize_sql {
my $self = shift;
my $query = shift;
$query ||= $self->{'query'};
# just in case it has not been called in the main script
$query = $self->query() if ( !$query );
my $re = qr{
(
(?:\\(?:copyright|errverbose|gx|gexec|gset|gdesc|q|crosstabview|watch|\?|copy|qecho|echo|if|elif|else|endif|edit|ir|include_relative|include|warn|write|html|print|out|ef|ev|h|H|i|p|r|s|w|o|e|g|q|d(?:[aAbcCdDeEfFgilLmnoOpPrRstTuvwxy+]{0,3})?|l\+?|sf\+?|sv\+?|z|a|C|f|H|t|T|x|c|pset|connect|encoding|password|conninfo|cd|setenv|timing|prompt|reset|set|unset|lo_export|lo_import|lo_list|lo_unlink|\!))(?:$|[\n]|[\ \t](?:(?!\\(?:\\|pset|reset|connect|encoding|password|conninfo|cd|setenv|timing|prompt|set|unset|lo_export|lo_import|lo_list|lo_unlink|\!|copy|qecho|echo|edit|html|include_relative|include|print|out|warn|watch|write|q))[\ \t\S])*) # psql meta-command
|
AAKEYWCONST\d+AA(?:\s+AAKEYWCONST\d+AA)+ # preserved multiple constants with newline
|
AAKEYWCONST\d+AA # preserved constants
|
\/\/ # mysql delimiter ( $$ is handled later with PG code delimiters )
|
\d*\.?\d+e[-+]\d+ # scientific notation with exponents
|
(?:COPY\s+[^\s]+\s+\((?:.*?)\\\.) # COPY and its content
|
[^\s\(,]+\%(?:ROWTYPE|TYPE) # single line comments
|
(?:\s*--)[\ \t\S]* # single line comments
|
(?:\-\|\-) # range operator "is adjacent to"
|
(?:\%[\d\-\*\$]*[sIL]) # format() placeholder
|
(?:<\%|\%>|<<\->|<\->>|<\->) # pg_trgm and some geometry operators
|
(?:\->>|\->|<\#>|\#>>|\#>|\?\&|\?\||\?|\@\?) # Vector and Json Operators
|
(?:\#<=|\#>=|\#<>|\#<|\#=) # compares tinterval and reltime
|
(?:>>=|<<=) # inet operators
|
(?:!!|\@\@\@) # deprecated factorial and full text search operators
|
(?:\|\|\/|\|\/) # square root and cube root
|
(?:\@\-\@|\@\@|\#\#|<<\||\|>>|\&<\||\&<|\|\&>|\&>|<\^|>\^|\?\#|\#|\?<\||\?\-\||\?\-|\?\|\||\?\||\@>|<\@|\~=)
# Geometric Operators
|
(?:~<=~|~>=~|~>~|~<~) # string comparison for pattern matching operator families
|
(?:!~~|!~~\*|~~\*|~~) # LIKE operators
|
(?:!~\*|!~|~\*) # regular expression operators
|
(?:\*=|\*<>|\*<=|\*>=|\*<|\*>) # composite type comparison operators
|
(?:\d+e[\+\-]\d+) # signed exponents
|
(?:<>|<=>|>=|<=|=>|==|!=|:=|=|!|<<|>>|<|>|\|\||\||&&|&|\-|\+|\*(?!/)|/(?!\*)|\%|~|\^|\?) # operators and tests
|
[\[\]\(\),;.] # punctuation (parenthesis, comma)
|
\"\"(?!\"") # empty double quoted string
|
"[^\"\s]+"\.[^\"\s\(\)=<>!~\*&:\|\-\+\%\^\?\@\#\[\]\{\}\.,;']+ # fqdn identifier form "schema".table or "table".column
|
[^\"\s=<>!~\*&\(\):\|\-\+\%\^\?\@\#\[\]\{\}\.,;']+\."[^\"\s]+" # fqdn identifier form schema."table" or table."column"
|
"[^\"\s]+"\."[^\"\s]+" # fqdn identifier form "schema"."table" or "table"."column"
|
"(?>(?:(?>[^"\\]+)|""|\\.)*)+" # anything inside double quotes, ungreedy
|
`(?>(?:(?>[^`\\]+)|``|\\.)*)+` # anything inside backticks quotes, ungreedy
|
[EB]*'[^']+' # anything inside single quotes, ungreedy.
|
/\*[\ \t\r\n\S]*?\*/ # C style comments
|
(?:[\w:\@]+[\$]*[\w:\@]*(?:\.(?:\w+|\*)?)*) # words, standard named placeholders, db.table.*, db.*
|
(?:\$\w+\$) # text delimiter
|
(?: \$_\$ | \$\d+ | \${1,2} | \$\w+\$) # dollar expressions - eg $_$ $3 $$ $BODY$
|
(?:\r\n){2,} # empty line Windows
|
\n{2,} # empty line Unix
|
\r{2,} # empty line Mac
|
[\t\ ]+ # any kind of white spaces
|
[^\s\*\/\-\\;:,]+ # anything else
)
}ismx;
my @query = grep { /\S/ } $query =~ m{$re}simxg;
if ( $self->{'keep_newline'} ) {
@query = grep { /(?:\S|^[\r\n]+$)/ } $query =~ m{$re}simxg;
}
# fix := operator that can not be found when attached to the variable name
for ( my $i = 0 ; $i < $#query ; $i++ ) {
if ( $query[$i] =~ /:$/ && $query[ $i + 1 ] =~ /^=/ ) {
$query[$i] =~ s/:$//;
$query[ $i + 1 ] =~ s/^/:/;
}
}
# Revert position when a comment is before a comma
if ( $self->{'comma'} eq 'end' ) {
for ( my $i = 0 ; $i < ( $#query - 1 ) ; $i++ ) {
if ( $query[ $i + 1 ] eq ',' and $self->_is_comment( $query[$i] ) )
{
$query[ $i + 1 ] = $query[$i];
$query[$i] = ',';
}
}
}
# Fix token split of negative numbers
if ( $#query > 2 ) {
for ( my $i = 2 ; $i <= $#query ; $i++ ) {
if (
$query[$i] =~ /^[\d\.]+$/ && $query[ $i - 1 ] =~ /^[\+\-]$/
and ( $query[ $i - 2 ] =~ /$math_operators/
or $query[ $i - 2 ] =~ /^(?:,|\(|\[)$/
or $self->_is_keyword( $query[ $i - 2 ] ) )
)
{
$query[$i] = $query[ $i - 1 ] . $query[$i];
$query[ $i - 1 ] = '';
}
elsif (
$query[$i] =~ /^[\d\.]+[^\d\.]+$/
and $query[ $i - 1 ] =~ /^\%$/
and ( $query[ $i - 2 ] =~ /$math_operators/
or $query[ $i - 2 ] =~ /^(?:,|\(|\[)$/
or $self->_is_keyword( $query[ $i - 2 ] )
or $self->_is_type( $query[ $i - 2 ] ) )
)
{
$query[$i] = $query[ $i - 1 ] . $query[$i];
$query[ $i - 1 ] = '';
}
elsif ($query[$i - 1] =~ /\$\w+$/ and $query[$i] eq '$')
{
$query[$i - 1] =~ s/(\$\w+)$//;
$query[$i] = $1 . $query[$i];
}
}
}
@query = grep( !/^$/, @query );
#print STDERR "DEBUG KWDLIST: ", join(' | ', @query), "\n";
return @query if (wantarray);
$self->{'_tokens'} = \@query;
}
sub _pop_level {
my ( $self, $token, $last_token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_POP: line: $line => last=", ( $last_token || '' ),
", token=$token\n";
}
return 0 if ( $#{ $self->{'_level_stack'} } == -1 );
return pop( @{ $self->{'_level_stack'} } ) || 0;
}
sub _reset_level {
my ( $self, $token, $last_token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_RESET: line: $line => last=",
( $last_token || '' ), ", token=$token\n";
}
@{ $self->{'_level_stack'} } = ();
$self->{'_level'} = 0;
$self->{'break'} = ' ' unless ( $self->{'spaces'} != 0 );
}
sub _set_level {
my ( $self, $position, $token, $last_token ) = @_;
my ( $package, $filename, $line ) = caller;
return 0 if ( not defined $position );
if ($DEBUG) {
print STDERR "DEBUG_SET: line: $line => position=$position, last=",
( $last_token || '' ), ", token=$token\n";
}
$self->{'_level'} = ( $position >= 0 ) ? $position : 0;
}
sub _push_level {
my ( $self, $position, $token, $last_token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_PUSH: line: $line => position=$position, last=",
( $last_token || '' ), ", token=$token\n";
}
push( @{ $self->{'_level_stack'} },
( ( $position >= 0 ) ? $position : 0 ) );
}
sub _set_last {
my ( $self, $token, $last_token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_LAST: line: $line => last=", ( $last_token || '' ),
", token=$token\n";
}
return $token;
}
=head2 beautify
Beautify SQL.
After calling this function, $object->content() will contain nicely indented result.
Code lifted from SQL::Beautify
=cut
sub beautify {
my $self = shift;
# Use to store the token position in the array
my $pos = 0;
# Main variables used to store differents state
$self->content('');
$self->{'_level'} = 0;
$self->{'_level_stack'} = [];
$self->{'_level_parenthesis'} = [];
$self->{'_new_line'} = 1;
$self->{'_current_sql_stmt'} = '';
$self->{'_current_full_sql_stmt'} = '';
$self->{'_is_meta_command'} = 0;
$self->{'_fct_code_delimiter'} = '';
$self->{'_language_sql'} = 0;
$self->{'_first_when_in_case'} = 0;
$self->{'_is_in_if'} = 0;
$self->{ '_is_in_return_query' } = 0;
$self->{'_is_in_set'} = 0;
$self->{'_is_in_conversion'} = 0;
$self->{'_is_in_case'} = ();
$self->{'_is_in_where'} = 0;
$self->{'_is_in_from'} = 0;
$self->{'_is_in_join'} = 0;
$self->{'_is_in_create'} = 0;
$self->{'_is_in_create_schema'} = 0;
$self->{'_is_in_rule'} = 0;
$self->{'_is_in_create_function'} = 0;
$self->{'_is_in_drop_function'} = 0;
$self->{'_is_in_alter'} = 0;
$self->{'_is_in_trigger'} = 0;
$self->{'_is_in_publication'} = 0;
$self->{'_is_in_call'} = 0;
$self->{'_is_in_type'} = 0;
$self->{'_is_in_domain'} = 0;
$self->{'_is_in_declare'} = 0;
$self->{'_is_in_block'} = -1;
$self->{'_is_in_work'} = 0;
$self->{'_is_in_function'} = 0;
$self->{'_current_function'} = '';
$self->{'_is_in_statistics'} = 0;
$self->{'_is_in_cast'} = 0;
$self->{'_is_in_procedure'} = 0;
$self->{'_is_in_index'} = 0;
$self->{'_is_in_with'} = 0;
$self->{'_is_in_explain'} = 0;
$self->{'_is_in_overlaps'} = 0;
$self->{'_parenthesis_level'} = 0;
$self->{'_parenthesis_function_level'} = 0;
$self->{'_has_order_by'} = 0;
$self->{'_is_in_order_by'} = 0;
$self->{'_has_over_in_join'} = 0;
$self->{'_insert_values'} = 0;
$self->{'_is_in_constraint'} = 0;
$self->{'_is_in_distinct'} = 0;
$self->{'_is_in_array'} = 0;
$self->{'_is_in_filter'} = 0;
$self->{'_parenthesis_filter_level'} = 0;
$self->{'_is_in_within'} = 0;
$self->{'_is_in_grouping'} = 0;
$self->{'_is_in_partition'} = 0;
$self->{'_is_in_over'} = 0;
$self->{'_is_in_policy'} = 0;
$self->{'_is_in_truncate'} = 0;
$self->{'_is_in_using'} = 0;
$self->{'_and_level'} = 0;
$self->{'_col_count'} = 0;
$self->{'_is_in_drop'} = 0;
$self->{'_is_in_operator'} = 0;
$self->{'_is_in_exception'} = 0;
$self->{'_is_in_sub_query'} = 0;
$self->{'_is_in_fetch'} = 0;
$self->{'_is_in_aggregate'} = 0;
$self->{'_is_in_value'} = 0;
$self->{'_parenthesis_level_value'} = 0;
$self->{'_parenthesis_with_level'} = 0;
$self->{'_is_in_returns_table'} = 0;
$self->{'_has_limit'} = 0;
$self->{'_not_a_type'} = 0;
$self->{'stmt_number'} = 1;
$self->{'_is_subquery'} = 0;
$self->{'_mysql_delimiter'} = '';
$self->{'_is_in_generated'} = 0;
$self->{'_is_in_between'} = 0;
$self->{'_is_in_materialized'} = 0;
$self->{'_is_closing_function'} = 0;
@{ $self->{'_begin_level'} } = ();
my $last = '';
$self->tokenize_sql();
$self->{'content'} .= "-- Statement # $self->{ 'stmt_number' }\n"
if ( $self->{'numbering'} and $#{ $self->{'_tokens'} } > 0 );
while ( defined( my $token = $self->_token ) ) {
my $rule = $self->_get_rule($token);
$self->{'_is_closing_function'} = 0;
if ( $self->{'keep_newline'}
and $self->{'_is_in_block'} >= 0
and $token =~ /^[\r\n]+$/s
and defined $last
and $last eq ';' )
{
$self->_add_token( $token, $last );
next;
}
# Replace concat operator found in some SGBD into || for normalization
if ( lc($token) eq 'concat'
&& defined $self->_next_token()
&& $self->_next_token ne '(' )
{
$token = '||';
}
# Case where a keyword is used as a column name.
if ( $self->{'_is_in_create'} > 1
and $self->_is_keyword( $token, $self->_next_token(), $last )
and defined $self->_next_token
and $self->_is_type( $self->_next_token ) )
{
$self->_add_token( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
# COPY block
if ( $token =~ /^COPY\s+[^\s]+\s+\(/i ) {
$self->_new_line( $token, $last );
$self->_add_token( $token, $last );
$self->_new_line( $token, $last );
$self->{'content'} .= "\n";
$last = $self->_set_last( $token, $last );
next;
}
if ( uc($token) eq 'BETWEEN' ) {
$self->{'_is_in_between'} = 1;
$self->_add_token( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
# mark when we are processing a materialized view to avoid formating issue with parameters
if ( uc($token) eq 'MATERIALIZED'
and uc( $self->_next_token ) eq 'VIEW' )
{
$self->{'_is_in_materialized'} = 1;
}
####
# Find if the current keyword is a known function name
####
if ( defined $last && $last && defined $self->_next_token
and $self->_next_token eq '(' )
{
my $word = lc($token);
$word =~ s/^[^\.]+\.//;
$word =~ s/^:://;
if ( uc($last) eq 'FUNCTION' and $token =~ /^\d+$/ ) {
$self->{'_is_in_function'}++;
}
elsif ( $word && exists $self->{'dict'}->{'pg_functions'}{$word} ) {
$self->{'_current_function'} = $word;
$self->{'_is_in_function'}++
if ( $self->{'_is_in_create'} != 1 or $token =~ /^CAST$/i );
# Try to detect user defined functions
}
elsif (
$last ne '*'
and !$self->_is_keyword( $token, $self->_next_token(), $last )
and ( exists $self->{'dict'}->{'symbols'}{$last}
or $last =~ /^\d+$/ )
)
{
$self->{'_is_in_function'}++;
}
elsif ( uc($token) eq 'IN'
and $self->{'_tokens'}[1] !~ /^(SELECT|WITH|VALUES)$/i )
{
$self->{'_is_in_function'}++;
# try to detect if this is a user function
}
elsif (
!$self->{'_is_in_function'}
and !$self->{'_is_in_create'}
and !$self->_is_comment($token)
and length($token) > 2 # lazy exclusion of operators/comma
and $last !~ /^(?:AS|RECURSIVE|WITH|OPERATOR|INTO|TYPE|VIEW)/i
and !$self->_is_keyword( $token, $self->_next_token(), $last )
)
{
$self->{'_is_in_function'}++;
}
}
####
# Set open parenthesis position to know if we
# are in subqueries or function parameters
####
if ( $token eq ')' ) {
$self->{'_parenthesis_filter_level'}--
if ( $self->{'_parenthesis_filter_level'} );
$self->{'_parenthesis_with_level'}--
if ( $self->{'_parenthesis_with_level'} );
$self->{'_is_in_filter'} = 0
if ( !$self->{'_parenthesis_filter_level'} );
if ( !$self->{'_is_in_function'} ) {
$self->{'_parenthesis_level'}--
if ( $self->{'_parenthesis_level'} > 0 );
}
else {
if ( $self->{'_parenthesis_function_level'} > 0 ) {
$self->{'_is_closing_function'} = 1;
$self->{'_parenthesis_function_level'}--;
}
if ( !$self->{'_parenthesis_function_level'} ) {
$self->_set_level(
pop( @{ $self->{'_level_parenthesis_function'} } ) || 0,
$token, $last
);
$self->_over( $token, $last )
if ( !$self->{'_is_in_create'}
&& !$self->{'_is_in_operator'}
&& !$self->{'_is_in_alter'}
and uc( $self->_next_token( $token, $last ) || '' ) ne
'LOOP' );
}
}
$self->{'_is_in_function'} = 0
if ( !$self->{'_parenthesis_function_level'} );
$self->{'_is_in_cast'} = 0
if (
(
not defined $self->_next_token
or $self->_next_token !~ /^(WITH|WITHOUT)$/i
)
and ( !$self->{'_parenthesis_level'}
or !$self->{'_parenthesis_function_level'} )
);
if (
!$self->{'_parenthesis_level'}
and $self->{'_is_in_sub_query'}
and defined $self->_next_token
and ( !$self->{'_is_in_order_by'}
or $self->_next_token =~ /^(FROM|GROUP)$/i )
)
{
$self->{'_is_in_sub_query'}--;
$self->_back( $token, $last );
}
if ( $self->{'_is_in_value'} ) {
$self->{'_parenthesis_level_value'}--
if ( $self->{'_parenthesis_level_value'} );
}
}
elsif ( $token eq '(' ) {
$self->{'_parenthesis_filter_level'}++
if ( $self->{'_is_in_filter'} );
$self->{'_parenthesis_with_level'}++ if ( $self->{'_is_in_with'} );
if ( $self->{'_is_in_function'} ) {
$self->{'_parenthesis_function_level'}++;
push(
@{ $self->{'_level_parenthesis_function'} },
$self->{'_level'}
) if ( $self->{'_parenthesis_function_level'} == 1 );
}
else {
if ( !$self->{'_parenthesis_level'} && $self->{'_is_in_from'} )
{
push(
@{ $self->{'_level_parenthesis'} },
$self->{'_level'}
);
}
$self->{'_parenthesis_level'}++;
if ( $self->{'_is_in_value'} ) {
$self->{'_parenthesis_level_value'}++;
}
}
if ( defined $self->_next_token
and $self->_next_token =~ /^(SELECT|WITH)$/i )
{
$self->{'_is_in_sub_query'}++
if ( defined $last and uc($last) ne 'AS' );
}
}
####
# Control case where we have to add a newline, go back and
# reset indentation after the last ) in the WITH statement
####
if (
$token =~ /^WITH$/i
and (
!defined $last
or
( $last ne ')' and $self->_next_token !~ /^(TIME|FUNCTION)/i )
)
)
{
if ( !$self->{'_is_in_partition'}
and !$self->{'_is_in_publication'}
and !$self->{'_is_in_policy'} )
{
$self->{'_is_in_with'} = 1
if ( !$self->{'_is_in_using'}
and !$self->{'_is_in_materialized'}
and uc( $self->_next_token ) ne 'ORDINALITY'
and uc($last) ne 'START' );
$self->{'no_break'} = 1
if ( uc( $self->_next_token ) eq 'ORDINALITY' );
}
$self->{'_is_in_materialized'} = 0;
}
elsif ( $token =~ /^WITH$/i
&& uc( $self->_next_token ) eq 'ORDINALITY' )
{
$self->{'no_break'} = 1;
}
elsif ($token =~ /^(AS|IS)$/i
&& defined $self->_next_token
&& $self->_next_token =~ /^(NOT|\()$/ )
{
$self->{'_is_in_materialized'} = 0;
$self->{'_is_in_with'}++ if ( $self->{'_is_in_with'} == 1 );
}
elsif ($self->{'_is_in_create'}
&& $token =~ /^AS$/i
&& defined $self->_next_token
&& uc( $self->_next_token ) eq 'SELECT' )
{
$self->{'_is_in_materialized'} = 0;
$self->{'_is_in_create'} = 0;
}
elsif ( $token eq '[' ) {
$self->{'_is_in_array'}++;
}
elsif ( $token eq ']' ) {
$self->{'_is_in_array'}-- if ( $self->{'_is_in_array'} );
}
elsif ( $token eq ')' ) {
$self->{'_has_order_by'} = 0;
if ( $self->{'_is_in_distinct'} ) {
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->{'_is_in_distinct'} = 0;
$last = $self->_set_last( $token, $last );
next;
}
$self->{'_is_in_generated'} = 0
if ( $self->{'_is_in_create'}
and $self->{'_parenthesis_level'} == 1 );
$self->{'_is_in_using'} = 0
if ( $self->{'_is_in_using'}
and !$self->{'_parenthesis_level'}
and !$self->{'_is_in_policy'} );
if (
defined $self->_next_token
and $self->_next_token !~ /^(AS|WITH|,)$/i
and (
!$self->_is_comment( $self->_next_token )
or ( $#{ $self->{'_tokens'} } >= 1
and $self->{'_tokens'}[1] ne ',' )
)
and !$self->{'_parenthesis_with_level'}
and $self->{'_is_in_with'}
)
{
$self->{'_is_in_with'} = 0;
$self->{'_is_in_from'} = 0;
}
if ( $self->{'_is_in_create'} > 1
and defined $self->_next_token
and uc( $self->_next_token ) eq 'AS'
and !$self->{'_is_in_with'} )
{
$self->{'_is_in_materialized'} = 0;
$self->_new_line( $token, $last )
if ( $last ne '(' and !$self->{'_is_in_create'} );
if ( $self->{'_is_in_returns_table'}
and !$self->{'_parenthesis_level'} )
{
$self->{'_is_in_returns_table'} = 0;
$self->_new_line( $token, $last );
$self->_back( $token, $last );
$self->_add_token( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
else {
$self->_over( $token, $last )
if ( $self->{'_is_in_procedure'} );
}
}
if ( ( $self->{'_is_in_with'} > 1 || $self->{'_is_in_operator'} )
&& !$self->{'_parenthesis_level'}
&& !$self->{'_parenthesis_with_level'}
&& !$self->{'_is_in_alter'}
&& !$self->{'_is_in_policy'} )
{
$self->_new_line( $token, $last )
if (
!$self->{'_is_in_operator'}
|| ( !$self->{'_is_in_drop'} and $self->_next_token eq ';' )
);
if ( !$self->{'_is_in_operator'} ) {
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
$self->_back( $token, $last );
}
$self->_add_token($token);
if ( !$self->{'_is_in_operator'} ) {
$self->_reset_level( $token, $last );
}
if ( $self->{'_is_in_with'} ) {
if ( defined $self->_next_token
&& $self->_next_token eq ',' )
{
$self->{'_is_in_with'} = 1;
}
else {
$self->{'_is_in_with'} = 0;
}
}
$last = $self->_set_last( $token, $last );
next;
}
}
elsif ( defined $self->_next_token && $self->_next_token eq '(' ) {
$self->{'_is_in_filter'} = 1 if ( uc($token) eq 'FILTER' );
$self->{'_is_in_grouping'} = 1
if ( $token =~ /^(GROUPING|ROLLUP)$/i );
}
elsif ( uc($token) eq 'PASSING'
and defined $self->_next_token && uc( $self->_next_token ) eq 'BY' )
{
$self->{'_has_order_by'} = 1;
}
# Explain need indentation in option list
if ( uc($token) eq 'EXPLAIN' ) {
$self->{'_is_in_explain'} = 1;
}
elsif ( uc($token) eq 'OVERLAPS' ) {
$self->{'_is_in_overlaps'} = 1;
}
if ($self->{'_current_sql_stmt'} eq 'DO UPDATE' && $token =~ /^(WHERE|SELECT)$/i) {
$self->{'_current_sql_stmt'} = 'INSERT';
$self->{'_is_in_set'} = 0;
}
####
# Set the current kind of statement parsed
####
if ( $token =~
/^(FUNCTION|PROCEDURE|SEQUENCE|INSERT|DELETE|UPDATE|SELECT|RAISE|ALTER|GRANT|REVOKE|COMMENT|DROP|RULE|COMMENT|LOCK)$/i
)
{
my $k_stmt = uc($1);
$self->{'_is_in_explain'} = 0;
$self->{'_is_in_where'} = 0;
$self->{'_current_full_sql_stmt'} = '';
# Set current statement with taking care to exclude of SELECT ... FOR UPDATE
# statement and ON CONFLICT DO UPDATE.
if (
$k_stmt ne 'UPDATE'
or ( defined $self->_next_token
and $self->_next_token ne ';'
and $self->_next_token ne ')'
and ( not defined $last or $last !~ /^(DO|SHARE)$/i ) )
)
{
if ( $k_stmt !~ /^(UPDATE|DELETE)$/i
|| !$self->{'_is_in_create'} )
{
if ( $self->{'_current_sql_stmt'} !~ /^(GRANT|REVOKE)$/i
and !$self->{'_is_in_trigger'}
and !$self->{'_is_in_operator'}
and !$self->{'_is_in_alter'} )
{
if ( $k_stmt ne 'COMMENT'
or $self->_next_token =~ /^(ON|IS)$/i )
{
$self->{'_current_sql_stmt'} = $k_stmt
if ( not defined $last or uc($last) ne 'WITH' );
}
}
}
if ( $self->{'_current_sql_stmt'} =~ /^(INSERT|DELETE|UPDATE|SELECT)$/i ) {
$self->{'_current_full_sql_stmt'} = "$self->{'_current_sql_stmt'} ";
for (my $i = 0; $i <= $#{ $self->{'_tokens'} }; $i++) {
last if ($self->{'_tokens'}[$i] eq ';');
$self->{'_current_full_sql_stmt'} .= " " . $self->{'_tokens'}[$i];
}
$self->{'_current_full_sql_stmt'} .= ";";
}
}
}
####
# Mark that we are in CREATE statement that need newline
# after a comma in the parameter, declare or column lists.
####
if ( $token =~ /^(FUNCTION|PROCEDURE)$/i
and $self->{'_is_in_create'}
and !$self->{'_is_in_trigger'} )
{
$self->{'_is_in_create_function'} = 1;
}
elsif ( $token =~ /^(FUNCTION|PROCEDURE)$/i
and defined $last
and uc($last) eq 'DROP' )
{
$self->{'_is_in_drop_function'} = 1;
}
elsif ( $token =~ /^(FUNCTION|PROCEDURE)$/i
and $self->{'_is_in_trigger'} )
{
$self->{'_is_in_index'} = 1;
}
if ( $token =~ /^CREATE$/i
and defined $self->_next_token
&& $self->_next_token !~
/^(EVENT|UNIQUE|INDEX|EXTENSION|TYPE|PUBLICATION|OPERATOR|RULE|CONVERSION|DOMAIN)$/i
)
{
if ( $self->_next_token =~ /^SCHEMA$/i ) {
$self->{'_is_in_create_schema'} = 1;
}
elsif ( $self->{'_is_in_create_schema'} ) {
# we are certainly in a create schema statement
$self->_new_line( $token, $last );
$self->{'_level'} = 1;
$self->{'_is_in_create_schema'}++;
}
$self->{'_is_in_create'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token && $self->_next_token =~ /^RULE$/i )
{
$self->{'_is_in_rule'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token && $self->_next_token =~ /^EVENT$/i )
{
$self->{'_is_in_trigger'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token && $self->_next_token =~ /^TYPE$/i )
{
$self->{'_is_in_type'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token
&& $self->_next_token =~ /^DOMAIN$/i )
{
$self->{'_is_in_domain'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token
&& $self->_next_token =~ /^PUBLICATION$/i )
{
$self->{'_is_in_publication'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token
&& $self->_next_token =~ /^CONVERSION$/i )
{
$self->{'_is_in_conversion'} = 1;
}
elsif ( $token =~ /^(CREATE|DROP)$/i
and defined $self->_next_token
&& $self->_next_token =~ /^OPERATOR$/i )
{
$self->{'_is_in_operator'} = 1;
$self->{'_is_in_drop'} = 1 if ( $token =~ /^DROP$/i );
}
elsif ( $token =~ /^ALTER$/i ) {
$self->{'_is_in_alter'}++;
}
elsif ( $token =~ /^DROP$/i ) {
$self->{'_is_in_drop'} = 1;
}
elsif ( $token =~ /^VIEW$/i and $self->{'_is_in_create'} ) {
$self->{'_is_in_index'} = 1;
$self->{'_is_in_create'} = 0;
}
elsif ( $token =~ /^STATISTICS$/i and $self->{'_is_in_create'} ) {
$self->{'_is_in_statistics'} = 1;
$self->{'_is_in_create'} = 0;
}
elsif ( $token =~ /^CAST$/i
and defined $self->_next_token
and $self->_next_token eq '(' )
{
$self->{'_is_in_cast'} = 1;
}
elsif ( $token =~ /^AGGREGATE$/i and $self->{'_is_in_create'} ) {
$self->{'_is_in_aggregate'} = 1;
$self->{'_has_order_by'} = 1;
}
elsif ( $token =~ /^EVENT$/i
and defined $self->_next_token
&& $self->_next_token =~ /^TRIGGER$/i )
{
$self->_over( $token, $last );
$self->{'_is_in_index'} = 1;
}
elsif ( $token =~ /^CREATE$/i
and defined $self->_next_token
&& $self->_next_token =~ /^INDEX|UNIQUE/i )
{
if ( $self->{'_is_in_create_schema'} ) {
$self->_new_line( $token, $last );
$self->{'_level'} = 1;
$self->{'_is_in_create_schema'}++;
}
}
if ( $self->{'_is_in_using'}
and defined $self->_next_token
and $self->_next_token =~ /^(OPERATOR|AS)$/i )
{
$self->{'_is_in_using'} = 0;
}
if ( $token =~ /^ALTER$/i and $self->{'_is_in_alter'} > 1 ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last ) if ( $last ne ',' );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
# Special case for MySQL delimiter
if ( uc($token) eq 'DELIMITER'
&& defined $self->_next_token
&& ( $self->_next_token eq '//' or $self->_next_token eq '$$' ) )
{
$self->{'_mysql_delimiter'} = $self->_next_token;
}
elsif (uc($token) eq 'DELIMITER'
&& defined $self->_next_token
&& $self->_next_token eq ';' )
{
$self->{'_mysql_delimiter'} = '';
}
# case of the delimiter alone
if ( $self->{'_mysql_delimiter'}
&& $token eq $self->{'_mysql_delimiter'} )
{
$self->{'content'} =~ s/\n\n$/\n/s;
$self->_add_token($token);
$self->_new_line( $token, $last );
$last = $self->_set_last( ';', $last );
next;
}
####
# Mark that we are in a CALL statement to remove any new line
####
if ( $token =~ /^CALL$/i ) {
$self->{'_is_in_call'} = 1;
}
# Increment operator tag to add newline in alter operator statement
if ( ( $self->{'_is_in_alter'} or uc($last) eq 'AS' )
and uc($token) eq 'OPERATOR' )
{
$self->_new_line( $token, $last )
if ( uc($last) eq 'AS' and uc($token) eq 'OPERATOR' );
$self->{'_is_in_operator'}++;
}
####
# Mark that we are in index/constraint creation statement to
# avoid inserting a newline after comma and AND/OR keywords.
# This also used in SET statement taking care that we are not
# in update statement. CREATE statement are not subject to this rule
####
if ( !$self->{'_is_in_create'}
and $token =~ /^(INDEX|PRIMARY|CONSTRAINT)$/i )
{
$self->{'_is_in_index'} = 1
if ( $last =~ /^(ALTER|CREATE|UNIQUE|USING|ADD)$/i );
}
elsif ( !$self->{'_is_in_create'} and uc($token) eq 'SET' ) {
$self->{'_is_in_index'} = 1
if ( $self->{'_current_sql_stmt'} ne 'UPDATE' );
}
elsif (
$self->{'_is_in_create'}
and (
uc($token) eq 'UNIQUE'
or ( $token =~ /^(PRIMARY|FOREIGN)$/i
and uc( $self->_next_token ) eq 'KEY' )
)
)
{
$self->{'_is_in_constraint'} = 1;
}
# Same as above but for ALTER FUNCTION/PROCEDURE/SEQUENCE or when
# we are in a CREATE FUNCTION/PROCEDURE statement
elsif ( $token =~ /^(FUNCTION|PROCEDURE|SEQUENCE)$/i
and !$self->{'_is_in_trigger'} )
{
$self->{'_is_in_index'} = 1
if ( uc($last) eq 'ALTER'
and !$self->{'_is_in_operator'}
and !$self->{'_is_in_alter'} );
if (
$token =~ /^FUNCTION$/i
&& ( $self->{'_is_in_create'}
|| $self->{'_current_sql_stmt'} eq 'COMMENT' )
)
{
$self->{'_is_in_index'} = 1 if ( !$self->{'_is_in_operator'} );
}
elsif ( $token =~ /^PROCEDURE$/i && $self->{'_is_in_create'} ) {
$self->{'_is_in_index'} = 1;
$self->{'_is_in_procedure'} = 1;
}
}
# Desactivate index like formatting when RETURN(S) keyword is found
elsif ( $token =~ /^(RETURN|RETURNS)$/i ) {
$self->{'_is_in_index'} = 0;
if ( uc($token) eq 'RETURNS'
and uc( $self->_next_token() ) eq 'TABLE' )
{
$self->{'_is_in_returns_table'} = 1;
}
}
elsif ( $token =~ /^AS$/i ) {
$self->{'_is_in_materialized'} = 0;
if ( !$self->{'_is_in_index'}
and $self->{'_is_in_from'}
and $last eq ')'
and uc($token) eq 'AS'
and $self->_next_token() eq '(' )
{
$self->{'_is_in_index'} = 1;
}
else {
$self->{'_is_in_index'} = 0;
}
$self->{'_is_in_block'} = 1 if ( $self->{'_is_in_procedure'} );
$self->{'_is_in_over'} = 0;
}
if ( $token =~ /^(BEGIN|DECLARE)$/i ) {
$self->{'_is_in_create'}-- if ( $self->{'_is_in_create'} );
if ( uc($token) eq 'BEGIN' ) {
push(
@{ $self->{'_begin_level'} },
( $#{ $self->{'_begin_level'} } < 0 )
? 0
: $self->{'_level'}
);
}
}
####
# Mark statements that use string_agg() or group_concat() function
# as statement that can have an ORDER BY clause inside the call to
# prevent applying order by formatting.
####
if (
$token =~ /^(string_agg|group_concat|array_agg|percentile_cont)$/i )
{
$self->{'_has_order_by'} = 1;
}
elsif ( $token =~ /^(?:GENERATED)$/i
and $self->_next_token =~ /^(ALWAYS|BY)$/i )
{
$self->{'_is_in_generated'} = 1;
}
elsif ( $token =~ /^(?:TRUNCATE)$/i ) {
$self->{'no_break'} = 1;
}
elsif ( uc($token) eq 'IDENTITY' ) {
$self->{'_has_order_by'} = 0;
$self->{'no_break'} = 0;
$self->{'_is_in_generated'} = 0;
}
elsif ( $self->{'_has_order_by'}
and uc($token) eq 'ORDER'
and $self->_next_token =~ /^BY$/i )
{
$self->_add_token( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $self->{'_has_order_by'} and uc($token) eq 'BY' ) {
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^OVER$/i ) {
$self->_add_token($token);
$self->{'_is_in_over'} = 1;
$self->{'_has_order_by'} = 1;
$last = $self->_set_last( $token, $last );
next;
}
# Fix case where we don't knwon if we are outside a SQL function
if ( defined $last
and uc($last) eq 'AS'
and defined $self->_next_token
and $self->_next_token eq ';'
and $self->{'_is_in_create_function'} )
{
$self->{'_is_in_create_function'} = 0;
}
####
# Set function code delimiter, it can be any string found after
# the AS keyword in function or procedure creation code
####
# Toogle _fct_code_delimiter to force next token to be stored as the function code delimiter
if (
uc($token) eq 'AS'
and ( !$self->{'_fct_code_delimiter'}
|| $self->_next_token =~ /CODEPART/ )
and $self->{'_current_sql_stmt'} =~ /^(FUNCTION|PROCEDURE)$/i
)
{
if ( $self->{'_is_in_create'}
and !$self->{'_is_in_with'}
and !$self->{'_is_in_cast'}
and $self->_next_token !~ /^(IMPLICIT|ASSIGNMENT)$/i )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
$self->{'_is_in_set'} = 0;
$self->_reset_level( $token, $last )
if ( $self->_next_token !~ /CODEPARTB/ );
}
else {
$self->_add_token($token);
}
if ( $self->_next_token !~ /(CODEPART|IMPLICIT|ASSIGNMENT)/
|| $self->_next_token =~ /^'/ )
{
if ( !$self->{'_is_in_cast'} and $self->{'_is_in_create'} ) {
# extract potential code joined with the code separator
if ( $self->{'_tokens'}->[0] =~ s/^'(.)/$1/ ) {
$self->{'_tokens'}->[0] =~ s/[;\s]*'$//;
my @tmp_arr =
$self->tokenize_sql( $self->{'_tokens'}->[0] );
push( @tmp_arr, ";", "'" );
shift( @{ $self->{'_tokens'} } );
unshift( @{ $self->{'_tokens'} }, "'", @tmp_arr );
}
$self->{'_fct_code_delimiter'} = '1';
}
}
$self->{'_is_in_create'} = 0;
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^(INSTEAD|ALSO)$/i
and defined $last
and uc($last) eq 'DO' )
{
$self->_add_token($token);
$self->_new_line( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^DO$/i
and defined $self->_next_token
and $self->_next_token =~ /^(INSTEAD|ALSO|UPDATE|NOTHING)$/i )
{
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^DO$/i
and !$self->{'_fct_code_delimiter'}
and $self->_next_token =~ /^\$[^\s]*/ )
{
@{ $self->{'_begin_level'} } = ();
$self->{'_fct_code_delimiter'} = '1';
$self->{'_is_in_create_function'} = 1;
$self->_new_line( $token, $last )
if ( $self->{'content'} !~ /\n$/s );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
$self->{_is_in_procedure} = 1;
next;
}
# Store function code delimiter
if ( $self->{'_fct_code_delimiter'} eq '1' ) {
if ( $self->_next_token =~ /CODEPART/ ) {
$self->{'_fct_code_delimiter'} = '0';
}
elsif ( $token =~ /^'.*'$/ ) {
$self->{'_fct_code_delimiter'} = "'";
}
else {
$self->{'_fct_code_delimiter'} = $token;
}
$self->_add_token($token);
if ( !$self->{'_is_in_create_function'}
or $self->_next_token ne ','
or $self->{'_tokens'}[1] !~ /KEYWCONST/ )
{
$self->_new_line( $token, $last );
}
if ( defined $self->_next_token
and $self->_next_token_skip_comment !~ /^(DECLARE|BEGIN)$/i )
{
$self->_over( $token, $last );
$self->{'_language_sql'} = 1;
}
if ( $self->{'_fct_code_delimiter'} eq "'" ) {
$self->{'_is_in_block'} = -1;
$self->{'_is_in_exception'} = 0;
$self->_reset_level( $token, $last )
if ( $self->_next_token eq ';' );
$self->{'_fct_code_delimiter'} = '';
$self->{'_current_sql_stmt'} = '';
$self->{'_is_in_procedure'} = 0;
$self->{'_is_in_function'} = 0;
$self->{'_is_in_create_function'} = 0;
$self->{'_language_sql'} = 0;
}
$last = $self->_set_last( $token, $last );
next;
}
# With SQL language the code delimiter can be include with the keyword, try to detect and fix it
if ( $self->{'_fct_code_delimiter'}
and $token =~ s/(.)\Q$self->{ '_fct_code_delimiter' }\E$/$1/ )
{
unshift( @{ $self->{'_tokens'} }, $self->{'_fct_code_delimiter'} );
}
# Desactivate the block mode when code delimiter is found for the second time
if ( $self->{'_fct_code_delimiter'}
&& $token eq $self->{'_fct_code_delimiter'} )
{
$self->{'_is_in_block'} = -1;
$self->{'_is_in_exception'} = 0;
$self->{'_is_in_create_function'} = 0;
$self->_reset_level( $token, $last );
$self->{'_fct_code_delimiter'} = '';
$self->{'_current_sql_stmt'} = '';
$self->{'_language_sql'} = 0;
$self->_new_line( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
####
# Mark when we are parsing a DECLARE or a BLOCK section. When
# entering a BLOCK section store the current indentation level
####
if ( uc($token) eq 'DECLARE' and $self->{'_is_in_create_function'} ) {
$self->{'_is_in_block'} = -1;
$self->{'_is_in_exception'} = 0;
$self->{'_is_in_declare'} = 1;
$self->_reset_level( $token, $last );
$self->_new_line( $token, $last );
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$last = $self->_set_last( $token, $last );
$self->{'_is_in_create_function'} = 0;
next;
}
elsif ( uc($token) eq 'ATOMIC' ) {
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->{'_is_in_block'}++;
# Store current indent position to print END at the right level
$self->_push_level( $self->{'_level'}, $token, $last );
next;
}
elsif ( uc($token) eq 'BEGIN' ) {
$self->{'_is_in_declare'} = 0;
if ( $self->{'_is_in_block'} == -1 ) {
$self->_reset_level( $token, $last );
}
$self->_new_line( $token, $last );
$self->_add_token($token);
if ( defined $self->_next_token
&& $self->_next_token !~
/^(WORK|TRANSACTION|ISOLATION|ATOMIC|;)$/i )
{
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->{'_is_in_block'}++;
# Store current indent position to print END at the right level
$self->_push_level( $self->{'_level'}, $token, $last );
}
$self->{'_is_in_work'}++
if ( !$self->{'no_grouping'}
and defined $self->_next_token
&& $self->_next_token =~
/^(WORK|TRANSACTION|ISOLATION|ATOMIC|;)$/i );
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^(COMMIT|ROLLBACK)$/i
and ( not defined $last or uc($last) ne 'ON' )
and !$self->{'_is_in_procedure'} )
{
$self->{'_is_in_work'} = 0;
$self->{'_is_in_declare'} = 0;
$self->{'_is_in_create_function'} = 0;
$self->_new_line( $token, $last );
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
@{ $self->{'_begin_level'} } = ();
next;
}
elsif ( $token =~ /^(COMMIT|ROLLBACK)$/i
and defined $self->_next_token
and $self->_next_token eq ';'
and $self->{'_is_in_procedure'} )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
@{ $self->{'_begin_level'} } = ();
next;
}
elsif ( $token =~ /^FETCH$/i and defined $last and $last eq ';' ) {
$self->_new_line( $token, $last );
$self->_back( $token, $last ) if ( $self->{'_is_in_block'} == -1 );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
$self->{'_is_in_fetch'} = 1;
next;
}
####
# Special case where we want to add a newline into ) AS (
####
if ( uc($token) eq 'AS' and $last eq ')' and $self->_next_token eq '(' )
{
$self->_new_line( $token, $last );
}
# and before RETURNS with increasing indent level
elsif ( uc($token) eq 'RETURNS' ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last )
if ( uc( $self->_next_token ) ne 'NULL' );
}
# and before WINDOW
elsif ( uc($token) eq 'WINDOW' ) {
$self->_new_line( $token, $last );
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
$self->{'_has_order_by'} = 1;
next;
}
# Treated DISTINCT as a modifier of the whole select clause, not only the first column only
if ( uc($token) eq 'ON' && defined $last && uc($last) eq 'DISTINCT' ) {
$self->{'_is_in_distinct'} = 1;
$self->_over( $token, $last );
}
elsif (uc($token) eq 'DISTINCT'
&& defined $last
&& uc($last) eq 'SELECT'
&& defined $self->_next_token
&& $self->_next_token !~ /^ON$/i )
{
$self->_add_token($token);
$self->_new_line( $token, $last ) if ( !$self->{'wrap_after'} );
$self->_over( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
if ($rule) {
$self->_process_rule( $rule, $token );
}
elsif ($token =~ /^(LANGUAGE|SECURITY|COST)$/i
&& !$self->{'_is_in_alter'}
&& !$self->{'_is_in_drop'}
&& $last ne ',' )
{
@{ $self->{'_begin_level'} } = ();
$self->_new_line( $token, $last )
if ( uc($token) ne 'SECURITY'
or ( defined $last and uc($last) ne 'LEVEL' ) );
$self->_add_token($token);
}
elsif ($token =~ /^PARTITION$/i
&& !$self->{'_is_in_over'}
&& defined $last
&& $last ne '(' )
{
$self->{'_is_in_partition'} = 1;
if ( $self->{'_is_in_create'} && defined $last and $last eq ')' ) {
$self->_new_line( $token, $last );
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last )
if ( $self->{'_level'} );
$self->_add_token($token);
}
else {
$self->_add_token($token);
}
}
elsif ( $token =~ /^POLICY$/i ) {
$self->{'_is_in_policy'} = 1;
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif ($token =~ /^TRUNCATE$/i
&& $self->_next_token !~ /^(TABLE|ONLY|,)$/i )
{
$self->{'_is_in_truncate'} = 1;
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
my $str_tmp = join( ' ', @{ $self->{'_tokens'} } );
$str_tmp =~ s/;.*//s;
if ( $str_tmp =~ / , /s ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->{'_is_in_truncate'} = 2;
}
next;
}
elsif ( $token =~ /^(TABLE|ONLY)$/i && uc($last) eq 'TRUNCATE' ) {
$self->{'_is_in_truncate'} = 1;
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
my $str_tmp = join( ' ', @{ $self->{'_tokens'} } );
$str_tmp =~ s/;.*//s;
if ( $str_tmp =~ / , /s ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->{'_is_in_truncate'} = 2;
}
next;
}
elsif ($token =~ /^(RESTART|CASCADE)$/i
&& $self->{'_is_in_truncate'} == 2 )
{
$self->_new_line( $token, $last );
$self->_back( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^TRIGGER$/i
and defined $last
and $last =~ /^(CREATE|CONSTRAINT|REPLACE)$/i )
{
$self->{'_is_in_trigger'} = 1;
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^(BEFORE|AFTER|INSTEAD)$/i
and $self->{'_is_in_trigger'} )
{
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif (
$token =~ /^EXECUTE$/i
and ( $self->{'_is_in_trigger'}
or ( defined $last and uc($last) eq 'AS' ) )
)
{
$self->_new_line( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token eq '(' ) {
if (
$self->{'_is_in_aggregate'} && defined $self->_next_token
and ( $self->_is_keyword( $self->_next_token )
or $self->_is_sql_keyword( $self->_next_token ) )
and uc( $self->_next_token ) ne 'VARIADIC'
)
{
$self->{'_is_in_aggregate'} = 0;
$self->{'_has_order_by'} = 0;
}
$self->{'_is_in_create'}++ if ( $self->{'_is_in_create'} );
$self->{'_is_in_constraint'}++ if ( $self->{'_is_in_constraint'} );
# case of insert with multiple values, don't stay single line
if (uc($last) eq 'VALUES' && $self->{'_current_sql_stmt'} eq 'INSERT' && $self->{'_current_full_sql_stmt'} =~ /\) , \(/) {
$self->_new_line( $token, $last );
$self->_over( $token, $last );
}
$self->_add_token( $token, $last );
if ( defined $self->_next_token
and uc( $self->_next_token ) eq 'SELECT' )
{
$self->{'_is_in_cast'} = 0;
$self->{'_is_subquery'}++;
}
if ( defined $self->_next_token
and $self->_next_token eq ')'
and !$self->{'_is_in_create'} )
{
$last = $self->_set_last( $token, $last );
next;
}
if ( !$self->{'_is_in_index'}
&& !$self->{'_is_in_publication'}
&& !$self->{'_is_in_distinct'}
&& !$self->{'_is_in_filter'}
&& !$self->{'_is_in_grouping'}
&& !$self->{'_is_in_partition'}
&& !$self->{'_is_in_over'}
&& !$self->{'_is_in_trigger'}
&& !$self->{'_is_in_policy'}
&& !$self->{'_is_in_aggregate'}
&& !$self->{'no_break'}
&& !$self->{'_is_in_generated'} )
{
if ( uc($last) eq 'AS'
|| $self->{'_is_in_create'} == 2
|| uc( $self->_next_token ) eq 'CASE' )
{
$self->_new_line( $token, $last )
if (
(
!$self->{'_is_in_function'}
or $self->_next_token =~ /^CASE$/i
)
and $self->_next_token ne ')'
and $self->_next_token !~ /^(PARTITION|ORDER)$/i
);
}
if ( $self->{'_is_in_with'} == 1 or $self->{'_is_in_explain'} )
{
$self->_over( $token, $last );
$self->_new_line( $token, $last )
if ( !$self->{'wrap_after'} );
$last = $self->_set_last( $token, $last )
if (!$self->{'_is_in_explain'}
|| $self->{'wrap_after'} );
next;
}
if ( !$self->{'_is_in_if'}
and !$self->{'_is_in_alter'}
and ( !$self->{'_is_in_function'} or $last ne '(' )
and uc($last) ne 'CHECK' )
{
$self->_over( $token, $last )
if ( $self->{'_is_in_operator'} <= 2
&& $self->{'_is_in_create'} <= 2 );
if ( !$self->{'_is_in_function'}
and !$self->_is_type( $self->_next_token ) )
{
if ( $self->{'_is_in_operator'} == 1 ) {
$self->_new_line( $token, $last );
$self->{'_is_in_operator'}++;
}
elsif ( $self->{'_is_in_type'} ) {
$self->_new_line( $token, $last );
}
}
$last = $self->_set_last( $token, $last );
}
if ( $self->{'_is_in_type'} == 1 ) {
$last = $self->_set_last( $token, $last );
next;
}
}
if (
$self->{'format_type'}
&& $self->{'_current_sql_stmt'} =~ /(FUNCTION|PROCEDURE)/i
&& $self->{'_is_in_create'} == 2
&& ( not defined $self->_next_token
or $self->_next_token ne ')' )
)
{
$self->_over( $token, $last )
if ( $self->{'_is_in_block'} < 0 );
$self->_new_line( $token, $last );
next;
}
}
elsif ( $token eq ')' ) {
if ( defined $self->_next_token ) {
my $next = quotemeta( $self->_next_token ) || 'SELECT';
if (
!$self->{'_parenthesis_level'}
and defined $self->_next_token
and $self->_is_keyword( $self->_next_token )
or ( !grep( /^$next$/, %{ $self->{'dict'}->{'symbols'} } ) )
)
{
$self->{'_is_in_where'} = 0;
}
}
if ( $self->{'_is_in_constraint'}
and defined $self->_next_token
and ( $self->_next_token eq ',' or $self->_next_token eq ')' ) )
{
$self->{'_is_in_constraint'} = 0;
}
elsif ( $self->{'_is_in_constraint'} ) {
$self->{'_is_in_constraint'}--;
}
# Case of CTE and explain
if ( $self->{'_is_in_with'} == 1 || $self->{'_is_in_explain'} ) {
$self->_back( $token, $last );
$self->_new_line( $token, $last )
if ( !$self->{'wrap_after'} && !$self->{'_is_in_overlaps'} );
$self->_add_token($token);
$last = $self->_set_last( $token, $last )
if ( $token ne ')' or uc( $self->_next_token ) ne 'AS' );
$self->{'_is_in_explain'} = 0;
next;
}
if (
(
$self->{'format_type'}
&& $self->{'_current_sql_stmt'} =~ /(FUNCTION|PROCEDURE)/i
&& $self->{'_is_in_create'} == 2
)
|| ( defined $self->_next_token
and uc( $self->_next_token ) eq 'INHERITS' )
)
{
$self->_back( $token, $last )
if ( $self->{'_is_in_block'} < 0 );
$self->_new_line( $token, $last )
if ( defined $last && $last ne '(' );
}
if (
$self->{'_is_in_index'}
|| $self->{'_is_in_alter'}
|| $self->{'_is_in_partition'}
|| $self->{'_is_in_policy'}
|| ( defined $self->_next_token
and $self->_next_token =~ /^OVER$/i )
)
{
$self->_add_token('');
$self->_add_token($token);
$self->{'_is_in_over'} = 0
if ( !$self->{'_parenthesis_level'} );
$last = $self->_set_last( $token, $last );
$self->{'_is_in_create'}-- if ( $self->{'_is_in_create'} );
next;
}
if ( defined $self->_next_token && $self->_next_token !~ /FILTER/i )
{
my $add_nl = 0;
$add_nl = 1
if (
$self->{'_is_in_create'} > 1
and defined $last
and $last ne '('
and !$self->{'_is_in_cast'}
and (
not defined $self->_next_token
or $self->_next_token =~
/^(TABLESPACE|PARTITION|AS|;)$/i
or ( $self->_next_token =~ /^ON$/i
and !$self->{'_parenthesis_level'} )
)
);
$add_nl = 1
if (
$self->{'_is_in_type'} == 1
and $self->_next_token !~ /^AS$/i
and ( not defined $self->_next_token
or $self->_next_token eq ';' )
);
$add_nl = 1
if (
$self->{'_current_sql_stmt'} ne 'INSERT'
and !$self->{'_is_in_function'}
and ( defined $self->_next_token
and $self->_next_token =~ /^(SELECT|WITH)$/i )
and $self->{'_tokens'}[1] !~ /^(ORDINALITY|FUNCTION)$/i
and ( $self->{'_is_in_create'}
or $last ne ')' and $last ne ']' )
and ( uc( $self->_next_token ) ne 'WITH'
or uc( $self->{'_tokens'}->[1] ) !~ /TIME|INOUT/i )
);
$self->_new_line( $token, $last ) if ($add_nl);
if ( !$self->{'_is_in_grouping'}
and !$self->{'_is_in_trigger'}
and !$self->{'no_break'}
and !$self->{'_is_in_generated'}
and $self->{'_is_in_create'} <= 2
and $self->_next_token !~ /^LOOP$/i )
{
$self->_back( $token, $last );
}
$self->{'_is_in_create'}-- if ( $self->{'_is_in_create'} );
}
if ( !$self->{'_parenthesis_level'} ) {
$self->{'_is_in_filter'} = 0;
$self->{'_is_in_within'} = 0;
$self->{'_is_in_grouping'} = 0;
$self->{'_is_in_over'} = 0;
$self->{'_has_order_by'} = 0;
$self->{'_is_in_policy'} = 0;
$self->{'_is_in_aggregate'} = 0;
}
$self->_add_token($token);
# Do not go further if this is the last token
if ( not defined $self->_next_token ) {
$last = $self->_set_last( $token, $last );
next;
}
# When closing CTE statement go back again
if (
(
$self->_next_token =~ /^(?:SELECT|INSERT|UPDATE|DELETE)$/i
and !$self->{'_is_in_policy'}
)
or ( $self->{'_is_in_with'}
and $self->{'_is_subquery'}
and $self->{'_is_subquery'} % 2 == 0 )
)
{
$self->_back( $token, $last )
if (
$self->{'_current_sql_stmt'} ne 'INSERT'
and !$self->{'_is_closing_function'}
and (
!$self->{'_parenthesis_level'}
or !defined $self->_next_token
or uc( $self->_next_token ) eq 'AS'
or ( $#{ $self->{'_tokens'} } >= 1
and $self->{'_tokens'}->[1] eq ',' )
)
);
}
$self->{'_is_subquery'}--
if (
$self->{'_is_subquery'}
and defined $self->_next_token
and $#{ $self->{'_tokens'} } >= 1
and ( uc( $self->_next_token ) eq 'AS'
or $self->{'_tokens'}->[1] eq ',' )
);
if ( $self->{'_is_in_create'} <= 1 ) {
my $next_tok = quotemeta( $self->_next_token );
$self->_new_line( $token, $last )
if (
defined $self->_next_token
and $self->_next_token !~
/^(?:AS|IS|THEN|INTO|BETWEEN|ON|IN|FILTER|WITHIN|DESC|ASC|WITHOUT|CASCADE)$/i
and ( $self->_next_token !~ /^(AND|OR)$/i
or !$self->{'_is_in_if'} )
and $self->_next_token ne ')'
and $self->_next_token !~ /^:/
and $self->_next_token ne ';'
and $self->_next_token ne ','
and $self->_next_token ne '||'
and uc( $self->_next_token ) ne 'CONCAT'
and ( $self->_is_keyword( $self->_next_token )
or $self->_is_function( $self->_next_token ) )
and $self->{'_current_sql_stmt'} !~ /^(GRANT|REVOKE)$/
and !exists $self->{'dict'}->{'symbols'}{$next_tok}
and !$self->{'_is_in_over'}
and !$self->{'_is_in_cast'}
and !$self->{'_is_in_domain'}
);
}
}
elsif ( $token eq ',' ) {
my $add_newline = 0;
# Format INSERT with multiple values
if ( $self->{'_current_sql_stmt'} eq 'INSERT'
and $last eq ')'
and $self->_next_token eq '(' )
{
$self->_new_line( $token, $last )
if ( $self->{'comma'} eq 'start' );
$self->_add_token($token);
$self->_new_line( $token, $last )
if ( $self->{'comma'} eq 'end' );
next;
}
$self->{'_is_in_constraint'} = 0
if ( $self->{'_is_in_constraint'} == 1 );
$self->{'_col_count'}++ if ( !$self->{'_is_in_function'} );
if ( ( $self->{'_is_in_over'} or $self->{'_has_order_by'} )
and !$self->{'_parenthesis_level'}
and !$self->{'_parenthesis_function_level'} )
{
$self->{'_is_in_over'} = 0;
$self->{'_has_order_by'} = 0;
$self->_back( $token, $last );
}
$add_newline = 1
if (
!$self->{'no_break'}
&& !$self->{'_is_in_generated'}
&& !$self->{'_is_in_function'}
&& !$self->{'_is_in_distinct'}
&& !$self->{'_is_in_array'}
&& ( $self->{'comma_break'}
|| $self->{'_current_sql_stmt'} ne 'INSERT' )
&& ( $self->{'_current_sql_stmt'} ne 'RAISE' )
&& ( $self->{'_current_sql_stmt'} !~ /^(FUNCTION|PROCEDURE)$/
|| $self->{'_fct_code_delimiter'} ne '' )
&& !$self->{'_is_in_where'}
&& !$self->{'_is_in_drop'}
&& !$self->{'_is_in_index'}
&& !$self->{'_is_in_aggregate'}
&& !$self->{'_is_in_alter'}
&& !$self->{'_is_in_publication'}
&& !$self->{'_is_in_call'}
&& !$self->{'_is_in_policy'}
&& !$self->{'_is_in_grouping'}
&& !$self->{'_is_in_partition'}
&& ( $self->{'_is_in_constraint'} <= 1 )
&& ( $self->{'_is_in_create'} <= 2 )
&& $self->{'_is_in_operator'} != 1
&& !$self->{'_has_order_by'}
&& $self->{'_current_sql_stmt'} !~ /^(GRANT|REVOKE)$/
&& (
$self->_next_token !~ /^('$|\s*\-\-)/is
or
( $self->_next_token !~ /^'$/is and $self->{'no_comments'} )
)
&& !$self->{'_parenthesis_function_level'}
&& ( !$self->{'_col_count'}
or $self->{'_col_count'} > ( $self->{'wrap_after'} - 1 ) )
|| ( $self->{'_is_in_with'} and !$self->{'wrap_after'} )
);
$self->{'_col_count'} = 0
if ( $self->{'_col_count'} > ( $self->{'wrap_after'} - 1 ) );
$add_newline = 0
if ( $self->{'_is_in_using'} and $self->{'_parenthesis_level'} );
$add_newline = 0 if ( $self->{'no_break'} );
if ( $self->{'_is_in_with'} >= 1 && !$self->{'_parenthesis_level'} )
{
$add_newline = 1 if ( !$self->{'wrap_after'} );
}
if ( $self->{'format_type'}
&& $self->{'_current_sql_stmt'} =~ /(FUNCTION|PROCEDURE)/i
&& $self->{'_is_in_create'} == 2 )
{
$add_newline = 1;
}
if ( $self->{'_is_in_alter'} && $self->{'_is_in_operator'} >= 2 ) {
$add_newline = 1
if ( defined $self->_next_token
and $self->_next_token =~ /^(OPERATOR|FUNCTION)$/i );
}
$add_newline = 1 if ( $self->{'_is_in_returns_table'} );
$self->_new_line( $token, $last )
if ( $add_newline and $self->{'comma'} eq 'start' );
$self->_add_token($token);
$add_newline = 0
if ( $self->{'_is_in_value'}
and $self->{'_parenthesis_level_value'} );
$add_newline = 0
if ( $self->{'_is_in_function'} or $self->{'_is_in_statistics'} );
$add_newline = 0
if ( defined $self->_next_token
and !$self->{'no_comments'}
and $self->_is_comment( $self->_next_token ) );
$add_newline = 0
if ( defined $self->_next_token and $#{$self->{'_tokens'}} >= 1
and $self->_next_token =~ /KEYWCONST/
and $#{$self->{'_tokens'}} >= 1 and $self->{'_tokens'}[1] =~ /^(LANGUAGE|STRICT)$/i );
$add_newline = 1 if ( $self->{'_is_in_truncate'} );
if (
$add_newline
and $self->{'comma'} eq 'end'
and ( $self->{'comma_break'}
|| ($self->{'_current_sql_stmt'} ne 'INSERT'
&& ($self->{'_current_sql_stmt'} ne 'DO UPDATE'
|| !$self->{'_parenthesis_level'})) )
)
{
$self->_new_line( $token, $last );
}
}
elsif ( $token eq ';' or $token =~ /^\\(?:g|crosstabview|watch)/ ) {
# statement separator or executing psql meta command (prefix 'g' includes all its variants)
$self->_add_token($token);
if ( $token eq ';'
and $#{ $self->{'_is_in_case'} } >= 0
and uc($last) ne 'CASE' ) {
$last = $self->_set_last( $token, $last );
next;
}
if ( $self->{'_is_in_type'} and $last eq ')' ) {
$self->_reset_level( $token, $last )
if ( $self->{'_is_in_block'} == -1
&& !$self->{'_parenthesis_level'} );
$self->{'_is_in_type'}--;
}
if ( $self->{'_is_in_rule'} ) {
$self->_back( $token, $last );
}
elsif ( $self->{'_is_in_create'} && $self->{'_is_in_block'} > -1 ) {
$self->_pop_level( $token, $last );
} elsif ( $self->{'_is_in_return_query'} ) {
$self->_pop_level( $token, $last );
}
# Initialize most of statement related variables
$self->{'no_break'} = 0;
$self->{'_is_in_generated'} = 0;
$self->{'_is_in_where'} = 0;
$self->{'_is_in_between'} = 0;
$self->{'_is_in_from'} = 0;
$self->{'_is_in_join'} = 0;
$self->{'_is_in_create'} = 0;
$self->{'_is_in_create_schema'} = 0;
$self->{'_is_in_alter'} = 0;
$self->{'_is_in_rule'} = 0;
$self->{'_is_in_publication'} = 0;
$self->{'_is_in_call'} = 0;
$self->{'_is_in_type'} = 0;
$self->{'_is_in_domain'} = 0;
$self->{'_is_in_function'} = 0;
$self->{'_current_function'} = '';
$self->{'_is_in_prodedure'} = 0;
$self->{'_is_in_index'} = 0;
$self->{'_is_in_statistics'} = 0;
$self->{'_is_in_cast'} = 0;
$self->{'_is_in_if'} = 0;
$self->{'_is_in_set'} = 0;
$self->{'_is_in_with'} = 0;
$self->{'_is_in_overlaps'} = 0;
$self->{'_has_order_by'} = 0;
$self->{'_has_over_in_join'} = 0;
$self->{'_parenthesis_level'} = 0;
$self->{'_parenthesis_function_level'} = 0;
$self->{'_is_in_constraint'} = 0;
$self->{'_is_in_distinct'} = 0;
$self->{'_is_in_array'} = 0;
$self->{'_is_in_filter'} = 0;
$self->{'_parenthesis_filter_level'} = 0;
$self->{'_is_in_partition'} = 0;
$self->{'_is_in_over'} = 0;
$self->{'_is_in_policy'} = 0;
$self->{'_is_in_truncate'} = 0;
$self->{'_is_in_trigger'} = 0;
$self->{'_is_in_using'} = 0;
$self->{'_and_level'} = 0;
$self->{'_col_count'} = 0;
$self->{'_is_in_drop'} = 0;
$self->{'_is_in_conversion'} = 0;
$self->{'_is_in_operator'} = 0;
$self->{'_is_in_explain'} = 0;
$self->{'_is_in_sub_query'} = 0;
$self->{'_is_in_fetch'} = 0;
$self->{'_is_in_aggregate'} = 0;
$self->{'_is_in_value'} = 0;
$self->{'_parenthesis_level_value'} = 0;
$self->{'_parenthesis_with_level'} = 0;
$self->{'_is_in_returns_table'} = 0;
$self->{'_has_limit'} = 0;
$self->{'_not_a_type'} = 0;
$self->{'_is_subquery'} = 0;
$self->{'_is_in_order_by'} = 0;
$self->{'_is_in_materialized'} = 0;
$self->{'_is_in_drop_function'} = 0;
$self->{'_current_full_sql_stmt'} = '';
$self->{ '_is_in_return_query' } = 0;
if ( $self->{'_insert_values'} ) {
if ( $self->{'_is_in_block'} == -1
and !$self->{'_is_in_declare'}
and !$self->{'_fct_code_delimiter'} )
{
$self->_reset_level( $token, $last );
}
elsif ( $self->{'_is_in_block'} == -1
and $self->{'_current_sql_stmt'} eq 'INSERT'
and !$self->{'_is_in_create'}
and !$self->{'_is_in_create_function'} )
{
$self->_back( $token, $last );
$self->_pop_level( $token, $last );
}
else {
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
}
$self->{'_insert_values'} = 0;
}
$self->{'_current_sql_stmt'} = '';
$self->{'break'} = "\n" unless ( $self->{'spaces'} != 0 );
#$self->_new_line($token,$last) if ($last !~ /^(VALUES|IMPLICIT|ASSIGNMENT)$/i);
$self->_new_line( $token, $last ) if ( $last !~ /^VALUES$/i );
# Add an additional newline after ; when we are not in a function
if ( $self->{'_is_in_block'} == -1
and !$self->{'_is_in_work'}
and !$self->{'_language_sql'}
and !$self->{'_is_in_declare'}
and uc($last) ne 'VALUES' )
{
$self->{'_new_line'} = 0;
$self->_new_line( $token, $last );
$self->{'stmt_number'}++;
$self->{'content'} .=
"-- Statement # $self->{ 'stmt_number' }\n"
if ( $self->{'numbering'} and $#{ $self->{'_tokens'} } > 0 );
}
# End of statement; remove all indentation when we are not in a BEGIN/END block
if ( !$self->{'_is_in_declare'}
and $self->{'_is_in_block'} == -1
and !$self->{'_fct_code_delimiter'}
and !$self->{'_is_in_exception'} )
{
$self->_reset_level( $token, $last );
}
elsif (
!$self->{'_language_sql'}
and ( not defined $self->_next_token
or $self->_next_token !~ /^INSERT$/ )
and !$self->{'_is_in_exception'}
)
{
if ( $#{ $self->{'_level_stack'} } == -1 ) {
$self->_set_level(
( $self->{'_is_in_declare'} )
? 1
: ( $self->{'_is_in_block'} + 1 ),
$token, $last
);
}
else {
$self->_set_level( $self->{'_level_stack'}[-1],
$token, $last );
}
}
$last = $self->_set_last( $token, $last );
}
elsif ( $token =~ /^FOR$/i ) {
if ( $self->{'_is_in_policy'} ) {
$self->_over( $token, $last );
$self->_new_line( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
if ( $self->_next_token =~ /^(UPDATE|KEY|NO|VALUES)$/i ) {
$self->_back( $token, $last )
if (
!$self->{'_has_limit'}
and ( $#{ $self->{'_level_stack'} } == -1
or $self->{'_level'} > $self->{'_level_stack'}[-1] )
);
$self->_new_line( $token, $last );
$self->{'_has_limit'} = 0;
}
elsif ( $self->_next_token =~ /^EACH$/
and $self->{'_is_in_trigger'} )
{
$self->_new_line( $token, $last );
}
$self->_add_token($token);
# cover FOR in cursor
$self->_over( $token, $last )
if ( uc( $self->_next_token ) eq 'SELECT' );
$last = $self->_set_last( $token, $last );
}
elsif ( $token =~ /^(?:FROM|WHERE|SET|RETURNING|HAVING|VALUES)$/i )
{
if ( uc($token) eq 'FROM'
and $self->{'_has_order_by'}
and !$self->{'_parenthesis_level'} )
{
$self->_back( $token, $last ) if ( $self->{'_has_order_by'} );
}
$self->{'no_break'} = 0;
$self->{'_col_count'} = 0;
$self->{'_is_in_set'} = 1
if ( uc($token) eq 'SET'
&& $self->{'_current_sql_stmt'} !~ /^(UPDATE|INSERT)$/i );
# special cases for create partition statement
if ( $token =~ /^VALUES$/i && defined $last
and $last =~ /^(FOR|IN)$/i )
{
$self->_add_token($token);
$self->{'no_break'} = 1;
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^FROM$/i && defined $last
and uc($last) eq 'VALUES' )
{
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
# Case of DISTINCT FROM clause
if ( $token =~ /^FROM$/i ) {
if ( uc($last) eq 'DISTINCT'
|| $self->{'_is_in_fetch'}
|| $self->{'_is_in_alter'}
|| $self->{'_is_in_conversion'}
|| $self->{'_is_in_set'} )
{
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
$self->{'_is_in_set'} = 0;
next;
}
$self->{'_is_in_from'}++
if ( !$self->{'_is_in_function'}
&& !$self->{'_is_in_partition'} );
}
if ( $token =~ /^WHERE$/i && !$self->{'_is_in_filter'} ) {
$self->_back( $token, $last )
if ( $self->{'_has_over_in_join'} );
$self->{'_is_in_where'}++;
$self->{'_is_in_from'}-- if ( $self->{'_is_in_from'} );
$self->{'_is_in_join'} = 0;
$self->{'_has_over_in_join'} = 0;
}
elsif ( !$self->{'_is_in_function'} ) {
$self->{'_is_in_where'}-- if ( $self->{'_is_in_where'} );
}
if ( $token =~ /^SET$/i and $self->{'_is_in_create'} ) {
# Add newline before SET statement in function header
$self->_new_line( $token, $last )
if ( not defined $last or $last !~ /^(DELETE|UPDATE)$/i );
}
elsif ( $token =~ /^WHERE$/i
and $self->{'_current_sql_stmt'} eq 'DELETE' )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
$self->_over( $token, $last );
$last = $self->_set_last( $token, $last );
$self->{'_is_in_join'} = 0;
$last = $self->_set_last( $token, $last );
next;
}
elsif ( $token =~ /^SET$/i
and defined $last
and uc($last) eq 'UPDATE'
and !$self->_is_keyword( $self->_next_token() ) )
{
$self->{'_is_in_index'} = 0;
$self->{'_is_in_from'} = 0;
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
elsif (
$token !~ /^FROM$/i
or ( !$self->{'_is_in_function'}
and !$self->{'_is_in_statistics'}
and $self->{'_current_sql_stmt'} !~ /(DELETE|REVOKE)/ )
)
{
if ( !$self->{'_is_in_filter'}
and ( $token !~ /^SET$/i or !$self->{'_is_in_index'} ) )
{
$self->_back( $token, $last )
if (
(
uc($token) ne 'VALUES'
or $self->{'_current_sql_stmt'} ne 'INSERT'
and $last ne "'"
)
and ( uc($token) !~ /^WHERE$/i
or $self->{'_is_in_with'} < 2
or $self->{'_level'} > 1 )
);
if ( uc($token) eq 'WHERE'
and $self->{'_is_in_function'}
and $self->{'_is_subquery'} <= 2 )
{
$self->_over( $token, $last );
}
$self->_new_line( $token, $last )
if (
!$self->{'_is_in_rule'}
and
( $last !~ /^DEFAULT$/i or $self->_next_token() ne ';' )
);
}
}
else {
if (
uc($token) eq 'FROM'
and $self->{'_is_in_sub_query'}
and !grep( /^\Q$last\E$/i, @extract_keywords )
and
( $self->{'_insert_values'} or $self->{'_is_in_function'} )
and (
!$self->{'_is_in_function'}
or !grep( /^$self->{ '_current_function' }$/,
@have_from_clause )
)
)
{
$self->_new_line( $token, $last );
$self->_back( $token, $last );
}
if ( uc($token) eq 'FROM' ) {
$self->{'_current_function'} = '';
}
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
if (
$token =~ /^VALUES$/i
and !$self->{'_is_in_rule'}
and !$self->{'comma_break'}
and ( $self->{'_current_sql_stmt'} eq 'INSERT' or $last eq '(' )
)
{
$self->_over( $token, $last )
if (uc($token) ne 'VALUES' || $self->{'_current_sql_stmt'} ne 'INSERT' || $self->{'_current_full_sql_stmt'} !~ /\) , \(/);
if ( $self->{'_current_sql_stmt'} eq 'INSERT' or $last eq '(' )
{
$self->{'_insert_values'} = 1;
$self->_push_level( $self->{'_level'}, $token, $last );
}
}
if ( $token =~ /^VALUES$/i and $last eq '(' ) {
$self->{'_is_in_value'} = 1;
}
if ( uc($token) eq 'WHERE' ) {
$self->_add_token( $token, $last );
$self->{'_is_in_value'} = 0;
$self->{'_parenthesis_level_value'} = 0;
}
else {
$self->_add_token($token);
}
if ( $token =~ /^VALUES$/i and $last eq '(' ) {
$self->_over( $token, $last );
}
elsif ($token =~ /^SET$/i
&& $self->{'_current_sql_stmt'} eq 'UPDATE' )
{
$self->_new_line( $token, $last ) if ( !$self->{'wrap_after'} );
$self->_over( $token, $last );
}
elsif (
!$self->{'_is_in_over'}
and !$self->{'_is_in_filter'}
and ( $token !~ /^SET$/i
or $self->{'_current_sql_stmt'} eq 'UPDATE' )
)
{
if (
defined $self->_next_token
and $self->_next_token !~ /\(|;/
and ( $self->_next_token !~ /^(UPDATE|KEY|NO)$/i
|| uc($token) eq 'WHERE' )
)
{
$self->_new_line( $token, $last )
if ( !$self->{'wrap_after'} );
$self->_over( $token, $last );
}
}
}
# Add newline before INSERT and DELETE if last token was AS (prepared statement)
elsif ( defined $last
and $token =~ /^(?:INSERT|DELETE|UPDATE)$/i
and uc($last) eq 'AS' )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
}
elsif ( $self->{'_current_sql_stmt'} !~ /^(GRANT|REVOKE)$/
and $token =~ /^(?:SELECT|PERFORM|UPDATE|DELETE)$/i
and ( !$self->{'_is_in_policy'} || $self->{'format_type'} ) )
{
$self->{'no_break'} = 0;
if ( $token =~ /^(SELECT|UPDATE|DELETE|INSERT)$/i
&& $self->{'_is_in_policy'} )
{
$self->_over( $token, $last );
}
# case of ON DELETE/UPDATE clause in create table statements
if ( $token =~ /^(UPDATE|DELETE)$/i && $self->{'_is_in_create'} ) {
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
if ( $token =~ /^UPDATE$/i and $last =~ /^(FOR|KEY|DO)$/i ) {
$self->_add_token($token);
if ( uc($last) eq 'DO' && uc( $self->_next_token ) eq 'SET' ) {
$self->{'_current_sql_stmt'} = 'DO UPDATE';
}
}
elsif (
!$self->{'_is_in_policy'}
&& $token !~ /^(DELETE|UPDATE)$/i
&& ( !defined $self->_next_token
|| $self->_next_token !~ /^DISTINCT$/i )
)
{
$self->_new_line( $token, $last )
if ( !defined $last or $last ne "\\\\" );
$self->_add_token($token);
$self->_new_line( $token, $last )
if ( !$self->{'wrap_after'}
and ( !defined $last or $last ne "\\\\" ) );
$self->_over( $token, $last );
}
else {
if ( $self->{'_is_in_policy'} > 1 ) {
$self->_new_line( $token, $last );
}
$self->_add_token($token);
if ( $self->{'_is_in_policy'} > 1 ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last );
}
$self->{'_is_in_policy'}++ if ( $self->{'_is_in_policy'} );
}
}
elsif ( $self->{'_current_sql_stmt'} !~ /^(GRANT|REVOKE)$/
and uc($token) eq 'INSERT'
and $self->{'_is_in_policy'} && $self->{'format_type'} )
{
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->_over( $token, $last );
}
elsif ( $token =~ /^(?:WITHIN)$/i ) {
$self->{'_is_in_within'} = 1;
$self->{'_has_order_by'} = 1;
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
elsif (
$token =~ /^(?:GROUP|ORDER|LIMIT|EXCEPTION)$/i
or
( uc($token) eq 'ON' and uc( $self->_next_token() ) eq 'CONFLICT' )
)
{
if ( $self->{'format_type'}
and uc($token) eq 'GROUP'
and uc( $self->_next_token() ) eq 'BY' )
{
$self->{'no_break'} = 1;
}
if ( uc($token) eq 'ORDER' and uc( $self->_next_token() ) eq 'BY' )
{
$self->{'_is_in_order_by'} = 1;
}
else {
$self->{'_is_in_order_by'} = 0;
}
$self->{'_is_in_value'} = 0;
$self->{'_parenthesis_level_value'} = 0;
if ( uc($token) eq 'GROUP' and !defined $last
or uc($last) eq 'EXCLUDE' )
{
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
if ( ( $self->{'_is_in_within'} && uc($token) eq 'GROUP' )
|| ( $self->{'_is_in_over'} && uc($token) eq 'ORDER' ) )
{
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
if ( $self->{'_has_over_in_join'} and uc($token) eq 'GROUP' ) {
$self->_back( $token, $last );
$self->{'_has_over_in_join'} = 0;
}
$self->{'_is_in_join'} = 0;
$self->{'_has_limit'} = 1 if ( uc($token) eq 'LIMIT' );
if ( $token !~ /^EXCEPTION/i ) {
$self->_back( $token, $last );
}
else {
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
}
if ( uc($token) ne 'EXCEPTION'
or not defined $last
or uc($last) ne 'RAISE' )
{
# Excluding CREATE/DROP GROUP
if ( uc($token) ne 'LIMIT' or !$self->{'_is_in_create'} ) {
$self->_new_line( $token, $last )
if ( !$self->{'_is_in_function'}
and ( not defined $last or $last !~ /^(CREATE|DROP)$/ )
);
}
}
# Store current indent position to print END at the right level
if ( uc($last) ne 'RAISE' and $token =~ /^EXCEPTION$/i ) {
$self->{'_is_in_exception'} = 1;
if ( $#{ $self->{'_begin_level'} } >= 0 ) {
$self->_set_level( $self->{'_begin_level'}[-1],
$token, $last );
}
}
elsif ( uc($last) eq 'RAISE' and $token =~ /^EXCEPTION$/i ) {
$self->_push_level( $self->{'_level'}, $token, $last );
$self->_over( $token, $last );
}
$self->{'_is_in_where'}-- if ( $self->{'_is_in_where'} );
$self->_add_token($token);
if ( $token =~ /^EXCEPTION$/i && $self->{'_level'} == 0 ) {
$self->_over( $token, $last );
}
}
elsif ( $token =~ /^(?:BY)$/i
and $last !~ /^(?:INCREMENT|OWNED|PARTITION|GENERATED)$/i )
{
$self->_add_token($token);
$self->{'_col_count'} = 0
if ( defined $last && $last =~ /^(?:GROUP|ORDER)/i );
if ( !$self->{'_has_order_by'} and !$self->{'_is_in_over'} ) {
$self->_new_line( $token, $last )
if ( !$self->{'wrap_after'} and !$self->{'_is_in_function'} );
$self->_over( $token, $last );
}
}
elsif ( $token =~ /^(?:CASE)$/i and uc($last) ne 'END' ) {
if ( $self->{'_is_in_policy'} ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->_add_token($token);
$self->{'_is_in_policy'}++;
}
else {
$self->_add_token($token);
}
# Store current indent position to print END at the right level
$self->_push_level( $self->{'_level'}, $token, $last );
# Mark next WHEN statement as first element of a case
# to force indentation only after this element
$self->{'_first_when_in_case'} = 1;
push( @{ $self->{'_is_in_case'} }, $self->{'_level'} );
}
elsif ($token =~ /^(?:WHEN)$/i
&& $self->_is_keyword( $token, $self->_next_token(), $last ) )
{
if ( !$self->{'_first_when_in_case'}
and !$self->{'_is_in_trigger'}
and defined $last
and uc($last) ne 'CASE' )
{
if ( !$self->{'_is_in_exception'} ) {
$self->_set_level( $self->{'_level_stack'}[-1],
$token, $last )
if ( $#{ $self->{'_level_stack'} } >= 0 );
}
elsif ( $#{ $self->{'_begin_level'} } >= 0 ) {
#$self->_set_level($self->{ '_begin_level' }[-1]+1, $token, $last);
$self->_set_level( $self->{'_begin_level'}[-1] + 1,
$token, $last );
}
}
$self->_new_line( $token, $last )
if ( not defined $last or $last !~ /^(CASE|,|\()$/i );
$self->_add_token($token);
if ( $#{ $self->{'_is_in_case'} } < 0
&& !$self->{'_is_in_trigger'} )
{
$self->_over( $token, $last );
}
$self->{'_first_when_in_case'} = 0;
}
elsif ($token =~ /^(?:IF|LOOP)$/i
&& $self->{'_current_sql_stmt'} ne 'GRANT' )
{
if ( $self->{'_is_in_join'} ) {
$self->{'_is_in_join'} = 0;
$self->_back( $token, $last );
$self->_add_token($token);
}
else {
$self->_add_token($token);
}
$self->{'no_break'} = 0;
if ( defined $self->_next_token
and $self->_next_token !~ /^(EXISTS|;)$/i )
{
if ( uc( $self->_next_token ) ne 'NOT'
|| uc( $self->{'_tokens'}->[1] ) ne 'EXISTS' )
{
$self->_new_line( $token, $last )
if ( $token =~ /^LOOP$/i );
$self->_over( $token, $last );
$self->_push_level( $self->{'_level'}, $token, $last );
if ( $token =~ /^IF$/i ) {
$self->{'_is_in_if'} = 1;
}
}
}
}
elsif ( $token =~ /^THEN$/i ) {
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->_set_level( $self->{'_level_stack'}[-1], $token, $last )
if ( $self->{'_is_in_if'}
and $#{ $self->{'_level_stack'} } >= 0 );
if ( $#{ $self->{'_is_in_case'} } >= 0
&& defined $self->_next_token()
and $self->_next_token() !~ /^(\(|RAISE)$/i )
{
$self->_set_level( $self->{'_level_stack'}[-1], $token, $last )
if ( $#{ $self->{'_level_stack'} } >= 0 );
$self->_over( $token, $last );
}
if ( $#{ $self->{'_is_in_case'} } >= 0
&& defined $self->_next_token()
and $self->_next_token() eq '('
and $self->{'_tokens'}[1] !~ /^(SELECT|CASE)$/i )
{
$self->_set_level( $self->{'_level_stack'}[-1], $token, $last )
if ( $#{ $self->{'_level_stack'} } >= 0 );
$self->_over( $token, $last );
}
$self->{'_is_in_if'} = 0;
}
elsif ( $token =~ /^(?:ELSE|ELSIF)$/i ) {
if ( $#{ $self->{'_is_in_case'} } < 0 ) {
$self->_back( $token, $last );
}
else {
$self->_set_level( $self->{'_is_in_case'}[-1], $token, $last );
}
$self->_new_line( $token, $last );
$self->_add_token($token);
$self->_new_line( $token, $last ) if ( $token !~ /^ELSIF$/i );
$self->_over( $token, $last );
}
elsif ( $token =~ /^(?:END)$/i ) {
$self->{'_first_when_in_case'} = 0;
if ( $#{ $self->{'_is_in_case'} } >= 0 ) {
pop( @{ $self->{'_is_in_case'} } );
$self->_back( $token, $last );
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
if ( !$self->{'_is_in_create_function'}
or $self->_next_token eq ';' )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
next;
}
}
# When we are not in a function code block (0 is the main begin/end block of a function)
elsif ( $self->{'_is_in_block'} == -1 && $last ne ',' ) {
# END is closing a create function statement so reset position to begining
if ( $self->_next_token !~
/^(IF|LOOP|CASE|INTO|FROM|END|ELSE|AND|OR|WHEN|AS|,)$/i )
{
$self->_reset_level( $token, $last );
}
else {
# otherwise back to last level stored at CASE keyword
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
}
}
# We reach the last end of the code
elsif ( $self->{'_is_in_block'} > -1
and $self->_next_token =~ /^(;|\$.*\$)$/
and !$self->{'_is_in_exception'} )
{
if ( $self->{'_is_in_block'} == 0 ) {
$self->_reset_level( $token, $last );
}
else {
$self->_set_level( $self->_pop_level( $token, $last ) - 1,
$token, $last );
$self->{'_is_in_block'}--;
}
}
# We are in code block
elsif ( $last ne ',' ) {
# decrease the block level if this is a END closing a BEGIN block
if ( $self->_next_token !~
/^(IF|LOOP|CASE|INTO|FROM|END|ELSE|AND|OR|WHEN|AS|,)$/i )
{
$self->{'_is_in_block'}--;
}
# Go back to level stored with IF/LOOP/BEGIN/EXCEPTION block
if ( $self->{'_is_in_block'} > -1 ) {
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
}
else {
$self->_reset_level( $token, $last );
}
}
if ( $self->_next_token eq ';' ) {
$self->_set_level( pop( @{ $self->{'_begin_level'} } ),
$token, $last );
}
elsif (!$self->{'_is_in_exception'}
and $self->_next_token !~ /^(AS|CASE|FROM|,)$/i )
{
$self->_back( $token, $last )
if ( $self->_next_token =~
/^(IF|LOOP|CASE|INTO|FROM|END|ELSE|AND|OR|WHEN|AS|,)$/i );
}
$self->_new_line( $token, $last );
$self->_add_token($token);
}
elsif ( $token =~ /^(?:END::[^\s]+)$/i
and $#{ $self->{'_is_in_case'} } >= 0 )
{
$self->{'_first_when_in_case'} = 0;
pop( @{ $self->{'_is_in_case'} } );
$self->_back( $token, $last );
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
$self->_new_line( $token, $last );
$self->_add_token($token);
}
elsif ( $token =~ /^(?:UNION|INTERSECT|EXCEPT)$/i ) {
$self->{'no_break'} = 0;
if ( $self->{'_is_in_join'} ) {
$self->_back( $token, $last );
$self->{'_is_in_join'} = 0;
}
if ($self->{'_is_in_return_query'} and $#{ $self->{'_level_stack'} } >= 0) {
$self->_set_level( $self->{'_level_stack'}[-1], $token, $last );
} else {
$self->_back( $token, $last ) unless defined $last and $last eq '(';
}
$self->_new_line( $token, $last );
$self->_add_token($token);
$self->_new_line( $token, $last )
if ( defined $self->_next_token
and $self->_next_token ne '('
and $self->_next_token !~ /^ALL$/i );
$self->{'_is_in_where'}-- if ( $self->{'_is_in_where'} );
$self->{'_is_in_from'} = 0;
}
elsif ( $token =~ /^(?:LEFT|RIGHT|FULL|INNER|OUTER|CROSS|NATURAL)$/i
and ( not defined $last or uc($last) ne 'MATCH' ) )
{
$self->{'no_break'} = 0;
if ( !$self->{'_is_in_join'} and ( defined $last and $last ne ')' ) ) {
$self->_back( $token, $last ) if ($#{ $self->{'_level_stack'} } < 0 or $self->{'_level'} > $self->{'_level_stack'}[-1]+1);
}
if ( $self->{'_has_over_in_join'} ) {
$self->{'_has_over_in_join'} = 0;
$self->_back( $token, $last );
}
if ( $token =~ /(?:LEFT|RIGHT|FULL|CROSS|NATURAL)$/i ) {
$self->_new_line( $token, $last );
$self->_over( $token, $last )
if (
$self->{'_level'} == 0
|| ( $self->{'_is_in_with'} > 1 and $self->{'_level'} == 1 )
);
}
if ( ( $token =~ /(?:INNER|OUTER)$/i )
&& ( $last !~ /(?:LEFT|RIGHT|CROSS|NATURAL|FULL)$/i ) )
{
$self->_new_line( $token, $last );
$self->_over( $token, $last ) if ( !$self->{'_is_in_join'} );
}
$self->_add_token($token);
}
elsif ( $token =~ /^(?:JOIN)$/i and !$self->{'_is_in_operator'} ) {
$self->{'no_break'} = 0;
if ( not defined $last
or $last !~ /^(?:LEFT|RIGHT|FULL|INNER|OUTER|CROSS|NATURAL)$/i )
{
$self->_new_line( $token, $last );
$self->_back( $token, $last )
if ( $self->{'_has_over_in_join'} );
$self->{'_has_over_in_join'} = 0;
}
$self->_add_token($token);
$self->{'_is_in_join'} = 1;
}
elsif ( $token =~ /^(?:AND|OR)$/i ) {
$self->{'_is_in_where'} = 0;
# Try to detect AND in BETWEEN clause to prevent newline insert
if (
uc($token) eq 'AND'
and (
$self->{'_is_in_between'}
|| ( defined $last
&& $last =~ /^(PRECEDING|FOLLOWING|ROW)$/i )
)
)
{
$self->_add_token($token);
$last = $self->_set_last( $token, $last );
$self->{'_is_in_between'} = 0;
next;
}
$self->{'no_break'} = 0;
if ( $self->{'_is_in_join'} ) {
$self->_over( $token, $last );
$self->{'_has_over_in_join'} = 1;
}
$self->{'_is_in_join'} = 0;
if ( !$self->{'_is_in_if'}
and !$self->{'_is_in_index'}
and ( not defined $last or $last !~ /^(?:CREATE)$/i )
and ( $self->{'_is_in_create'} <= 2 )
and !$self->{'_is_in_trigger'} )
{
$self->_new_line( $token, $last );
if ( !$self->{'_and_level'}
and ( !$self->{'_level'} || $self->{'_is_in_alter'} ) )
{
$self->_over( $token, $last );
}
elsif ( $self->{'_and_level'}
and !$self->{'_level'}
and uc($token) eq 'OR' )
{
$self->_over( $token, $last );
}
elsif ( $#{ $self->{'_level_stack'} } >= 0
and $self->{'_level'} == $self->{'_level_stack'}[-1] )
{
$self->_over( $token, $last );
}
}
$self->_add_token($token);
$self->{'_and_level'}++;
}
elsif ( $token =~ /^\/\*.*\*\/$/s ) {
if ( !$self->{'no_comments'} ) {
$token =~ s/\n[\s\t]+\*/\n\*/gs;
if ( !$self->{'_is_in_over'} and !$self->{'_is_in_function'} ) {
$self->_new_line( $token, $last ), $self->_add_token('')
if ( defined $last and $last eq ';' );
$self->_new_line( $token, $last );
}
$self->_add_token($token);
$self->{'break'} = "\n" unless ( $self->{'spaces'} != 0 );
if (
!$self->{'_is_in_function'}
and !$self->{'_is_in_over'}
and ( !$self->_is_comment($token)
or !defined $self->_next_token
or $self->_next_token ne ')' )
)
{
$self->_new_line( $token, $last );
}
$self->{'break'} = " " unless ( $self->{'spaces'} != 0 );
}
}
elsif (
(
$token =~ /^USING$/i
and !$self->{'_is_in_order_by'}
and !$self->{'_is_in_exception'}
and ( $self->{'_current_sql_stmt'} ne 'DELETE'
or uc( $self->_next_token ) !~ /^(\(|LATERAL)$/i )
)
or ( uc($token) eq 'WITH'
and uc( $self->_next_token() ) eq 'CHECK'
and $self->{'_is_in_policy'} )
)
{
if ( !$self->{'_is_in_from'} ) {
$self->_over( $token, $last )
if (
$self->{'_is_in_operator'}
|| ( $self->{'_is_in_policy'}
&& !$self->{'format_type'}
&& !$self->{'_is_in_using'} )
);
$self->_push_level( $self->{'_level'}, $token, $last )
if ( $token =~ /^USING$/i );
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last )
if ( uc($token) eq 'WITH'
and $self->{'_is_in_policy'} > 1
&& !$self->{'format_type'}
&& $self->{'_is_in_using'} );
$self->_new_line( $token, $last )
if ( uc($last) ne 'EXCLUDE'
and !$self->{'_is_in_index'}
and !$self->{'_is_in_function'} );
}
else {
# USING from join clause disable line break like in function
$self->{'_is_in_function'}++;
# Restore FROM position
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last )
if ( !$self->{'_is_in_join'} );
}
$self->_add_token($token);
if (defined $self->_next_token and uc($self->_next_token) eq 'ERRCODE') {
$self->_set_level( $self->_pop_level( $token, $last ),
$token, $last );
}
$self->{'_is_in_using'} = 1;
$self->{'_is_in_policy'}++
if ( !$self->{'_is_in_from'}
&& !$self->{'_is_in_join'}
&& uc($last) ne 'EXCLUDE'
&& !$self->{'_is_in_function'}
&& !$self->{'_is_in_operator'}
&& !$self->{'_is_in_create'}
&& !$self->{'_is_in_index'} );
}
elsif ( $token =~ /^EXCLUDE$/i ) {
if ( $last !~ /^(FOLLOWING|ADD)$/i
or $self->_next_token !~ /^USING$/i )
{
$self->_new_line( $token, $last )
if ( $last !~ /^(FOLLOWING|ADD)$/i );
}
$self->_add_token($token);
$self->{'_is_in_using'} = 1;
}
elsif ( $token =~ /^\\\S/ ) {
# treat everything starting with a \ and at least one character as psql meta command.
$self->_add_token($token);
$self->_new_line( $token, $last )
if ( $token ne "\\\\"
and defined $self->_next_token
and $self->_next_token ne "\\\\" );
}
elsif (
$token =~ /^(ADD|DROP)$/i
&& ( $self->{'_current_sql_stmt'} eq 'SEQUENCE'
|| $self->{'_current_sql_stmt'} eq 'ALTER' )
)
{
if (
$self->_next_token !~ /^(NOT|NULL|DEFAULT)$/i
and ( not defined $last
or !$self->{'_is_in_alter'}
or $last ne '(' )
)
{
$self->_new_line( $token, $last );
if ( $self->{'_is_in_alter'} < 2 ) {
$self->_over( $token, $last );
}
}
$self->_add_token( $token, $last );
$self->{'_is_in_alter'}++ if ( $self->{'_is_in_alter'} == 1 );
}
elsif ($token =~ /^INCREMENT$/i
&& $self->{'_current_sql_stmt'} eq 'SEQUENCE' )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
}
elsif ( $token =~ /^NO$/i
and $self->_next_token =~ /^(MINVALUE|MAXVALUE)$/i )
{
$self->_new_line( $token, $last );
$self->_add_token($token);
}
elsif ( $last !~ /^(\(|NO)$/i and $token =~ /^(MINVALUE|MAXVALUE)$/i ) {
$self->_new_line( $token, $last );
$self->_add_token($token);
}
elsif ( $token =~ /^CACHE$/i ) {
$self->_new_line( $token, $last );
$self->_add_token($token);
}
else {
next if ( $self->{'keep_newline'} and $token =~ /^\s+$/ );
if ( $self->{'_fct_code_delimiter'}
and $self->{'_fct_code_delimiter'} =~ /^'.*'$/ )
{
$self->{'_fct_code_delimiter'} = "";
$self->{'_language_sql'} = 0;
}
if ( $self->{'_is_in_block'} != -1
and !$self->{'_fct_code_delimiter'} )
{
$self->{'_is_in_block'} = -1;
$self->{'_is_in_procedure'} = 0;
$self->{'_is_in_function'} = 0;
}
# special case with comment
if ( $token =~ /(?:\s*--)[\ \t\S]*/s ) {
if ( !$self->{'no_comments'} ) {
$token =~ s/^(\s*)(--.*)/$2/s;
my $start = $1 || '';
if ( $start =~ /\n/s ) {
$self->_new_line( $token, $last ), $self->_add_token('')
if ( defined $last
and $last eq ';'
and $self->{'content'} !~ /\n$/s );
$self->_new_line( $token, $last );
}
$token =~ s/\s+$//s;
$token =~ s/^\s+//s;
$self->_add_token($token);
$self->_new_line( $token, $last )
if (
$start
|| ( $self->{'content'} !~ /\n$/s
&& defined $self->_next_token
&& uc( $self->_next_token ) ne 'AS' )
);
# Add extra newline after the last comment if we are not in a block or a statement
if ( defined $self->_next_token
and $self->_next_token !~ /^\s*--/ )
{
$self->{'content'} .= "\n"
if ( $self->{'_is_in_block'} == -1
and !$self->{'_is_in_declare'}
and !$self->{'_fct_code_delimiter'}
and !$self->{'_current_sql_stmt'}
and defined $last
and $self->_is_comment($last)
and $self->{'content'} !~ /\n$/s );
}
$last = $self->_set_last( $token, $last );
}
next;
}
if ( $last =~ /^(?:SEQUENCE)$/i
and $self->_next_token !~ /^(OWNED|;)$/i )
{
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->_over( $token, $last );
}
else {
if (
defined $last
&& $last eq ')'
&& ( !defined $self->_next_token
|| $self->_next_token ne ';' )
)
{
if ( !$self->{'_parenthesis_level'}
&& !$self->{'_has_over_in_join'}
&& $self->{'_is_in_from'} )
{
$self->_set_level(
pop( @{ $self->{'_level_parenthesis'} } ) || 1,
$token, $last );
}
}
if ( defined $last
and uc($last) eq 'UPDATE'
and $self->{'_current_sql_stmt'} eq 'UPDATE' )
{
$self->_new_line( $token, $last );
$self->_over( $token, $last );
}
if ( defined $last
and uc($last) eq 'AS'
and uc($token) eq 'WITH' )
{
$self->_new_line( $token, $last );
}
if ( uc($token) eq 'INSERT' and defined $last and $last eq ';' )
{
if ( $#{ $self->{'_level_stack'} } >= 0 ) {
$self->_set_level( $self->{'_level_stack'}[-1],
$token, $last );
}
else {
if ( !$self->{_is_in_procedure}
|| $self->{'_level'} > 1 )
{
$self->_back( $token, $last );
}
}
}
if (
(
$self->{'_is_in_policy'} > 1
|| ( $self->{'_is_in_policy'}
&& $self->{'_is_in_sub_query'} )
)
&& $token =~ /^(ALL|SELECT|UPDATE|DELETE|INSERT)$/i
)
{
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$self->_add_token($token);
$self->_new_line( $token, $last );
$self->_over( $token, $last );
$last = $self->_set_last( $token, $last );
next;
}
$self->{'_is_in_policy'}++
if ( $token =~ /^SELECT$/i and $self->{'_is_in_policy'} );
if ( $self->{'comma_break'}
and $self->{'_current_sql_stmt'} eq 'INSERT'
&& $last eq '(' )
{
$self->_new_line( $token, $last );
}
# Remove extra newline at end of code of SQL functions
if ( $token eq "'"
and $last eq ';'
and $self->_next_token =~
/^(;|LANGUAGE|STRICT|SET|IMMUTABLE|STABLE|VOLATILE)$/i )
{
$self->{'content'} =~ s/\s+$/\n/s;
}
if ($#{ $self->{'_is_in_case'} } >= 0 && defined $last && $last eq ';') {
$self->_new_line( $token, $last );
}
# Finally add the token without further condition
$self->_add_token( $token, $last );
if (uc($token) eq 'RETURN' and $self->_next_token =~ /^QUERY$/i) {
$self->_push_level( $self->{'_level'}, $token, $last );
$self->{ '_is_in_return_query' } = 1;
}
if ( $last eq "'" and $token =~ /^(BEGIN|DECLARE)$/i ) {
$last = $self->_set_last( $token, $last );
$self->_new_line( $token, $last );
$self->_over( $token, $last );
}
# Reset CREATE statement flag when using CTE
if ( $self->{'_is_in_create'}
&& $self->{'_is_in_with'}
&& uc($token) eq 'WITH'
&& uc($last) eq 'AS' )
{
$self->{'_is_in_create'} = 0;
}
if (
defined $last
&& uc($last) eq 'LANGUAGE'
&& $self->_is_keyword( $last, $token )
&& ( !defined $self->_next_token
|| $self->_next_token ne ';' )
)
{
$self->_new_line( $token, $last );
}
}
}
$last = $self->_set_last( $token, $last );
$pos++;
}
if ( $self->{'no_extra_line'} ) {
$self->_new_line() if ( $self->{'content'} !~ /;$/s );
$self->{'content'} =~ s/\s+$/\n/s;
}
else {
$self->_new_line();
}
# Attempt to remove usless spaces
$self->{'content'} =~ s/\s+CHECK\s+\(\s+/ CHECK (/igs;
# Attempt to eliminate redundant parenthesis in DML queries
if ( !$self->{'redundant_parenthesis'} ) {
while ( $self->{'content'} =~
s/(\s+(?:WHERE|SELECT|FROM)\s+(?!TO)\s+[^;]+)[\(]{2}([^\(\)]+)[\)]{2}([^;]+)/$1($2)$3/igs
)
{
}
}
# Add newline after ariga/atlas related comments
$self->{'content'} =~ s/(\-\-\s*atlas:[^\n]+)/$1\n/gs;
return;
}
sub _lower {
my ( $self, $token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_ADD: line: $line => token=$token\n";
}
return lc($token);
}
=head2 _add_token
Add a token to the beautified string.
Code lifted from SQL::Beautify
=cut
sub _add_token {
my ( $self, $token, $last_token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_ADD: line: $line => last=", ( $last_token || '' ),
", token=$token\n";
}
if ( $self->{'wrap'} ) {
my $wrap;
if ( $self->_is_keyword( $token, $self->_next_token(), $last_token ) ) {
$wrap = $self->{'wrap'}->{'keywords'};
}
elsif ( $self->_is_constant($token) ) {
$wrap = $self->{'wrap'}->{'constants'};
}
if ($wrap) {
$token = $wrap->[0] . $token . $wrap->[1];
}
}
if ( $self->{keep_newline}
and $self->{'_is_in_block'} >= 0
and $token =~ /^[\r\n]+$/s
and defined $last_token
and $last_token eq ';' )
{
$token =~ s/^[\r\n]+$/\n/s;
$self->{'content'} =~ s/\s+$/\n/s;
$self->{'content'} .= $token if ( $self->{'content'} !~ /[\n]{2,}$/s );
return;
}
my $last_is_dot = defined($last_token) && $last_token eq '.';
#$DEBUG_SP = 1;
my $sp = $self->_indent;
if ( !$self->_is_punctuation($token) and !$last_is_dot ) {
if ( ( !defined($last_token) || $last_token ne '(' )
&& $token ne ')'
&& $token !~ /^::/ )
{
if (
$token ne ')'
&& defined($last_token)
&& $last_token !~ '::$'
&& $last_token ne '['
&& ( $token ne '(' || !$self->_is_type($last_token) )
&& ( $token ne '('
|| !$self->_is_function($last_token)
|| $self->{'_is_in_type'} )
)
{
print STDERR "DEBUG_SPC: 1) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
if ( ( $token !~ /PGFESCQ[12]/ or $last_token !~ /'$/ )
and ( $last_token !~ /PGFESCQ[12]/ or $token !~ /^'/ ) )
{
if ( $token !~ /^['"].*['"]$/ or $last_token ne ':' ) {
if ( $token =~ /AAKEYWCONST\d+AA\s+AAKEYWCONST\d+AA/ ) {
$token =~ s/(AAKEYWCONST\d+AA)/$sp$1/gs;
}
else {
$self->{'content'} .= $sp
if (
!$self->{'no_space_function'}
or $token ne '('
or ( !$self->{'_is_in_drop_function'}
and !$self->{'_is_in_create_function'}
and !$self->{'_is_in_trigger'} )
);
if (
$self->{'no_space_function'}
and $token eq '('
and (
!$self->_is_keyword( $last_token, $token,
undef )
or $self->_is_type($last_token)
)
)
{
$self->{'content'} =~ s/$sp$//s;
}
}
}
}
}
elsif ( !defined($last_token) && $token ) {
print STDERR "DEBUG_SPC: 2) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp;
}
elsif ( $token eq '('
and $self->{'_is_in_create'} == 2
and $self->{'content'} !~ /$sp$/ )
{
print STDERR "DEBUG_SPC: 2b) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp;
}
elsif ( defined $last_token && $self->_is_comment($last_token) ) {
print STDERR "DEBUG_SPC: 2c) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp;
}
}
elsif (defined $last_token
&& $last_token eq '('
&& $token ne ')'
&& $token !~ /^::/
&& !$self->{'wrap_after'}
&& $self->{'_is_in_with'} == 1 )
{
print STDERR "DEBUG_SPC: 3) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp;
}
elsif ( $self->{'_is_in_create'} == 2 && defined($last_token) ) {
if ( $last_token ne '::'
and !$self->{'_is_in_partition'}
and !$self->{'_is_in_policy'}
and !$self->{'_is_in_trigger'}
and !$self->{'_is_in_aggregate'}
and ( $last_token ne '(' || !$self->{'_is_in_index'} ) )
{
print STDERR "DEBUG_SPC: 4) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp
if ( $last_token ne '(' or !$self->{'_is_in_function'});
if ($token =~ /^::/) {
$self->{'content'} =~ s/$sp$//s;
}
}
}
elsif ( defined $last_token
and ( !$self->{'_is_in_operator'} or !$self->{'_is_in_alter'} ) )
{
if (
$last_token eq '('
and (
$self->{'_is_in_type'}
or (
$self->{'_is_in_operator'}
and !$self->_is_type(
$token, $last_token, $self->_next_token
)
)
)
)
{
print STDERR "DEBUG_SPC: 5a) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp
if ( !$self->{'_is_in_type'} || $token !~ /^\d+$/ );
}
elsif ( $self->{'comma_break'}
and $self->{'_current_sql_stmt'} eq 'INSERT' )
{
print STDERR "DEBUG_SPC: 5b) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp;
}
}
elsif ( $token eq ')'
and $self->{'_is_in_block'} >= 0 && $self->{'_is_in_create'} )
{
print STDERR "DEBUG_SPC: 6) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
$self->{'content'} .= $sp;
}
else {
print STDERR "DEBUG_SPC: 7) last=", ( $last_token || '' ),
", token=$token\n"
if ($DEBUG_SP);
}
if ( $self->_is_comment($token) ) {
my @lines = split( /\n/, $token );
for ( my $i = 1 ; $i <= $#lines ; $i++ ) {
if ( $lines[$i] =~ /^\s*\*/ ) {
$lines[$i] =~ s/^\s*\*/$sp */;
}
elsif ( $lines[$i] =~ /^\s+[^\*]/ ) {
$lines[$i] =~ s/^\s+/$sp /;
}
}
$token = join( "\n", @lines );
}
else {
$token =~ s/\n/\n$sp/gs
if ( $self->{'_is_in_function'}
and $self->{'_fct_code_delimiter'} eq "'" );
}
}
my $next_token = $self->_next_token || '';
my @cast = ();
my @next_cast = ();
# Be sure that we not going to modify a constant
if ( $self->{'_is_in_create'} < 2 and $token !~ /^[E]*'.*'$/ ) {
@cast = split( /::/, $token, -1 );
$token = shift(@cast) if ( $#cast >= 0 );
@next_cast = split( /::/, $next_token );
$next_token = shift(@next_cast) if ( $#next_cast >= 0 );
}
# lowercase/uppercase keywords taking care of function with same name
if (
$self->_is_keyword( $token, $next_token, $last_token )
and (
!$self->_is_type($next_token)
or $self->{'_is_in_create'} < 2
or $self->{'_is_in_cast'}
or
( $self->{'_is_in_create'} == 2 and $token =~ /^(WITH|WITHOUT)$/i )
or $self->{'_is_in_create_function'}
or uc($token) eq 'AS'
)
and ( $next_token ne '('
or ( defined $last_token and $last_token =~ /^(CREATE|ALTER)$/i )
or !$self->_is_function($token) )
)
{
# Be sure that we are not formating with time zone
if ( uc($token) ne 'WITH'
or not defined $next_token
or $next_token !~ /^(time|timestamp)$/i )
{
$token = lc($token) if ( $self->{'uc_keywords'} == 1 );
$token = uc($token) if ( $self->{'uc_keywords'} == 2 );
$token = ucfirst( lc($token) ) if ( $self->{'uc_keywords'} == 3 );
}
}
else {
# lowercase/uppercase known functions or words followed by an open parenthesis
# if the token is not a keyword, an open parenthesis or a comment
my $fct = $self->_is_function( $token, $last_token, $next_token ) || '';
if ( $fct and
((
$next_token eq '('
and defined $last_token
and uc($last_token) ne 'CREATE'
)
or ( !$self->_is_keyword( $token, $next_token, $last_token )
and $next_token ne '('
and $token ne '('
and !$self->_is_comment($token) ))
)
{
$token =~ s/$fct/\L$fct\E/i if ( $self->{'uc_functions'} == 1 );
$token =~ s/$fct/\U$fct\E/i if ( $self->{'uc_functions'} == 2 );
$fct = ucfirst( lc($fct) );
$token =~ s/$fct/$fct/i if ( $self->{'uc_functions'} == 3 );
}
# case of (NEW|OLD).colname keyword that need to formatted too
if (
(
$self->{'_is_in_create_function'}
or $self->{'_fct_code_delimiter'}
or $self->{'_is_in_rule'}
)
and $token =~ /^(NEW|OLD)\./i
)
{
$token =~ s/^(OLD|NEW)\./\L$1\E\./i
if ( $self->{'uc_keywords'} == 1 );
$token =~ s/^(OLD|NEW)\./\U$1\E\./i
if ( $self->{'uc_keywords'} == 2 );
$token =~ s/^OLD\./\UOld\E\./i if ( $self->{'uc_keywords'} == 3 );
$token =~ s/^NEW\./\UNew\E\./i if ( $self->{'uc_keywords'} == 3 );
}
}
my $tk_is_type = $self->_is_type( $token, $last_token, $next_token );
if ( $token =~ /^(AT|SET)$/i ) {
$self->{'_not_a_type'} = 1;
}
elsif ( !$tk_is_type ) {
$self->{'_not_a_type'} = 0;
}
# Type are always lowercase
if (
!$self->{'_not_a_type'}
and ( $self->{'_is_in_create'}
or $self->{'_is_in_declare'}
or $self->{'_is_in_cast'}
or $self->{'_is_in_type'}
or $self->{'_is_in_alter'} )
)
{
if (
$tk_is_type and defined $last_token
or ( $token =~ /^(WITH|WITHOUT)$/i
and $next_token =~ /^(time|timestamp)$/i )
)
{
if ( $last_token =~ /^(AS|RETURNS|INOUT|IN|OUT)$/i
or !$self->_is_keyword($last_token)
or $self->_is_type($last_token)
or $self->_is_type($next_token) )
{
$token = lc($token) if ( $self->{'uc_types'} == 1 );
$token = uc($token) if ( $self->{'uc_types'} == 2 );
$token = ucfirst( lc($token) ) if ( $self->{'uc_types'} == 3 );
}
}
}
# Add formatting for HTML output
if ( $self->{'colorize'} && $self->{'format'} eq 'html' ) {
$token = $self->highlight_code( $token, $last_token, $next_token );
}
foreach my $c (@cast) {
my @words = split( /(\s+)/, $c );
$c = '';
foreach my $w (@words) {
if ( !$self->_is_type($token) ) {
$c .= $w;
}
else {
$c .= lc($w) if ( $self->{'uc_types'} == 1 );
$c .= uc($w) if ( $self->{'uc_types'} == 2 );
$c .= ucfirst( lc($w) ) if ( $self->{'uc_types'} == 3 );
}
}
$token .= '::' . $c;
}
# Format cast in function code
my $reg = join( '|', @{ $self->{'types'} } );
$reg =
'(?:TIMESTAMP(\s*\(\s*\d+\s*\))? WITH TIME ZONE|TIMESTAMP(\s*\(\s*\d+\s*\))? WITHOUT TIME ZONE|CHARACTER VARYING|'
. $reg . ')';
if ( $token =~ /::/ ) {
$token =~ s/::($reg)/'::' . lc($1)/igse if ( $self->{'uc_types'} == 1 );
$token =~ s/::($reg)/'::' . uc($1)/igse if ( $self->{'uc_types'} == 2 );
$token =~ s/::($reg)/'::' . ucfirst(lc($1))/igse
if ( $self->{'uc_types'} == 3 );
}
# special case for MySQL
if ( $token =~ /^(;|\$\$|\/\/)$/ and $self->{'content'} =~ /DELIMITER\s*$/ )
{
$self->{'content'} .= ' ' if ( $self->{'content'} !~ /DELIMITER\s$/ );
}
$self->{'content'} .= $token;
# This can't be the beginning of a new line anymore.
$self->{'_new_line'} = 0;
}
=head2 _over
Increase the indentation level.
Code lifted from SQL::Beautify
=cut
sub _over {
my ( $self, $token, $last ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_OVER: line: $line => last=$last, token=$token\n";
}
++$self->{'_level'};
}
=head2 _back
Decrease the indentation level.
Code lifted from SQL::Beautify
=cut
sub _back {
my ( $self, $token, $last ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_BACK: line: $line => last=$last, token=$token\n";
}
--$self->{'_level'} if ( $self->{'_level'} > 0 );
}
=head2 _indent
Return a string of spaces according to the current indentation level and the
spaces setting for indenting.
Code lifted from SQL::Beautify
=cut
sub _indent {
my ($self) = @_;
if ( $self->{'_new_line'} ) {
return $self->{'space'} x
( $self->{'spaces'} * ( $self->{'_level'} // 0 ) );
}
# When this is not for identation force using space
else {
return ' ';
}
}
=head2 _new_line
Add a line break, but make sure there are no empty lines.
Code lifted from SQL::Beautify
=cut
sub _new_line {
my ( $self, $token, $last ) = @_;
if ( $DEBUG and defined $token ) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_NL: line: $line => last=", ( $last || '' ),
", token=$token\n";
}
$self->{'content'} .= $self->{'break'} unless ( $self->{'_new_line'} );
$self->{'_new_line'} = 1;
}
=head2 _next_token
Have a look at the token that's coming up next.
Code lifted from SQL::Beautify
=cut
sub _next_token {
my ($self) = @_;
return @{ $self->{'_tokens'} } ? $self->{'_tokens'}->[0] : undef;
}
=head2 _next_token_skip_comment
Have a look at the token that's coming up next omitting comments.
Code lifted from SQL::Beautify
=cut
sub _next_token_skip_comment {
my ($self) = @_;
for ( my $i = 0 ; $i <= $#{ $self->{'_tokens'} } ; $i++ ) {
next if ( $self->{'_tokens'}->[$i] =~ /^\s*(--|\/\*)/ );
return $self->{'_tokens'}->[$i];
}
return undef;
}
=head2 _token
Get the next token, removing it from the list of remaining tokens.
Code lifted from SQL::Beautify
=cut
sub _token {
my ($self) = @_;
return shift @{ $self->{'_tokens'} };
}
=head2 _is_keyword
Check if a token is a known SQL keyword.
Code lifted from SQL::Beautify
=cut
sub _is_keyword {
my ( $self, $token, $next_token, $last_token ) = @_;
if ($DEBUG) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_KEYWORD: line: $line => last=",
( $last_token || '' ), ", token=$token\n";
}
return 0 if ( !$token );
# Remove cast if any
$token =~ s/::[^:]+$//;
$next_token //= '';
# Fix some false positive
if ( defined $next_token ) {
return 0 if ( uc($token) eq 'LEVEL' and uc($next_token) ne 'SECURITY' );
return 0 if ( uc($token) eq 'EVENT' and uc($next_token) ne 'TRIGGER' );
return 0
if ( $self->{'_current_sql_stmt'} =~ /(INSERT|UPDATE)/
and $next_token =~ /^[,\)=]$/
and ( not defined $last_token or $last_token =~ /^[,\(]$/ )
and $token !~
/^(TRUE|FALSE|DEFAULT|NULL|CURRENT_.*|LEXIZE|END)$/i );
}
return 0
if ( $token =~ /^(LOGIN|RULE)$/i
and !$self->{'_is_in_create'}
and !$self->{'_is_in_alter'}
and !$self->{'_is_in_drop'}
and !$self->{'_is_in_rule'} );
return 0
if ( uc($token) eq 'COMMENT'
and ( not defined $next_token or $next_token ) !~ /^ON|IS$/i );
if ( defined $last_token ) {
return 0
if ( uc($token) eq 'KEY'
and $last_token !~ /^(PRIMARY|FOREIGN|PARTITION|NO)$/i );
return 0
if ( $token =~ /^(BTREE|HASH|GIST|SPGIST|GIN|BRIN)$/i
and $last_token !~ /^(USING|BY)$/i );
return 0 if ( uc($token) eq 'NOTICE' and uc($last_token) ne 'RAISE' );
return 0
if ( ( $self->{'_is_in_type'} or $self->{'_is_in_create'} )
and $last_token =~ /^(OF|FROM)$/i );
return 0
if ( uc($last_token) eq 'AS'
and $token !~
/^(IDENTITY|SELECT|ENUM|TRANSACTION|UPDATE|DELETE|INSERT|MATERIALIZED|ON|VALUES|RESTRICTIVE|PERMISSIVE|UGLY|EXECUTE|STORAGE|OPERATOR|RANGE|NOT)$/i
);
return 0
if ( $token =~ /^(TYPE|SCHEMA)$/i
and $last_token =~ /^(COLUMN|\(|,|\||\))/i );
return 0
if ( $token =~ /^TYPE$/i
and $last_token !~ /^(CREATE|DROP|ALTER|FOR)$/i
and !$self->{'_is_in_alter'}
and !grep( { uc($_) eq uc($next_token) } @{ $self->{'types'} } ) );
}
# False negative
return 1 if ($token =~ /^QUERY$/i and defined $last_token and uc($last_token) eq 'RETURN');
if ( $DEBUG
and defined $token
and grep { $_ eq uc($token) } @{ $self->{'keywords'} } )
{
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_KEYWORD: line: $line => last=",
( $last_token || '' ), ", token=$token, next=",
( $next_token || '' ), "\n";
}
return ~~ grep { $_ eq uc($token) } @{ $self->{'keywords'} };
}
=head2 _is_type
Check if a token is a known SQL type
=cut
sub _is_type {
my ( $self, $token, $last_token, $next_token ) = @_;
return if ( !defined $token );
return if ( defined $next_token and $next_token =~ /^(SEARCH)$/i );
if ( $DEBUG and defined $token ) {
my ( $package, $filename, $line ) = caller;
print STDERR "DEBUG_TYPE: line: $line => token=[$token], last=",
( $last_token || '' ), ", next=", ( $next_token || '' ), ", type=",
( grep { uc($_) eq uc($token) } @{ $self->{'types'} } ), "\n";
}
return 0
if ( $token =~ /^(int4|int8|num|tstz|ts|date)range$/i
and ( not defined $next_token or $next_token eq '(' ) );
my @composite_types = ( 'VARYING', 'PRECISION', 'WITH', 'WITHOUT', 'ZONE' );
# Typically case of a data type used as an object name
if ( defined $next_token ) {
if ( grep { $_ eq uc($token) } @{ $self->{'types'} }
and grep { $_ eq uc($next_token) } @{ $self->{'types'} }
and !grep { $_ eq uc($next_token) } @composite_types )
{
return 0;
}
}
$token =~ s/\s*\(.*//; # remove any parameter to the type
return ~~ grep { $_ eq uc($token) } @{ $self->{'types'} };
}
sub _is_sql_keyword {
my ( $self, $token ) = @_;
return ~~ grep { $_ eq uc($token) } @{ $self->{'sql_keywords'} };
}
=head2 _is_comment
Check if a token is a SQL or C style comment
=cut
sub _is_comment {
my ( $self, $token ) = @_;
return 1 if ( $token =~ m#^\s*((?:--)[\ \t\S]*|/\*[\ \t\r\n\S]*?\*/)$#s );
return 0;
}
=head2 _is_function
Check if a token is a known SQL function.
Code lifted from SQL::Beautify and rewritten to check one long regexp instead of a lot of small ones.
=cut
sub _is_function {
my ( $self, $token, $last_token, $next_token ) = @_;
return undef if ( !$token );
if ( $token =~ $self->{'functions_re'} ) {
# Check the context of the function
if ( defined $last_token and defined $next_token ) {
return undef if ( $next_token ne '(' );
return undef if ( $self->{'_is_in_create'} == 1 );
}
return $1;
}
else {
return undef;
}
}
=head2 add_keywords
Add new keywords to highlight.
Code lifted from SQL::Beautify
=cut
sub add_keywords {
my $self = shift;
for my $keyword (@_) {
push @{ $self->{'keywords'} }, ref($keyword) ? @{$keyword} : $keyword;
}
}
=head2 _re_from_list
Create compiled regexp from prefix, suffix and and a list of values to match.
=cut
sub _re_from_list {
my $prefix = shift;
my $suffix = shift;
my ( @joined_list, $ret_re );
for my $list_item (@_) {
push @joined_list, ref($list_item) ? @{$list_item} : $list_item;
}
$ret_re = "$prefix(" . join( '|', @joined_list ) . ")$suffix";
return qr/$ret_re/i;
}
=head2 _refresh_functions_re
Refresh compiled regexp for functions.
=cut
sub _refresh_functions_re {
my $self = shift;
$self->{'functions_re'} =
_re_from_list( '\b[\.]*', '$', @{ $self->{'functions'} } );
}
=head2 add_functions
Add new functions to highlight.
Code lifted from SQL::Beautify
=cut
sub add_functions {
my $self = shift;
for my $function (@_) {
push @{ $self->{'functions'} },
ref($function) ? @{$function} : $function;
}
$self->_refresh_functions_re();
}
=head2 add_rule
Add new rules.
Code lifted from SQL::Beautify
=cut
sub add_rule {
my ( $self, $format, $token ) = @_;
my $rules = $self->{'rules'} ||= {};
my $group = $rules->{$format} ||= [];
push @{$group}, ref($token) ? @{$token} : $token;
}
=head2 _get_rule
Find custom rule for a token.
Code lifted from SQL::Beautify
=cut
sub _get_rule {
my ( $self, $token ) = @_;
values %{ $self->{'rules'} }; # Reset iterator.
while ( my ( $rule, $list ) = each %{ $self->{'rules'} } ) {
return $rule if ( grep { uc($token) eq uc($_) } @$list );
}
return;
}
=head2 _process_rule
Applies defined rule.
Code lifted from SQL::Beautify
=cut
sub _process_rule {
my ( $self, $rule, $token ) = @_;
my $format = {
break => sub { $self->_new_line() },
over => sub { $self->_over() },
back => sub { $self->_back() },
token => sub { $self->_add_token($token) },
push => sub { push @{ $self->{'_level_stack'} }, $self->{'_level'} },
pop => sub { $self->{'_level'} = $self->_pop_level( $token, '' ) },
reset =>
sub { $self->{'_level'} = 0; @{ $self->{'_level_stack'} } = (); },
};
for ( split /-/, lc $rule ) {
&{ $format->{$_} } if ( $format->{$_} );
}
}
=head2 _is_constant
Check if a token is a constant.
Code lifted from SQL::Beautify
=cut
sub _is_constant {
my ( $self, $token ) = @_;
return ( $token =~ /^\d+$/ or $token =~ /^(['"`]).*\1$/ );
}
=head2 _is_punctuation
Check if a token is punctuation.
Code lifted from SQL::Beautify
=cut
sub _is_punctuation {
my ( $self, $token ) = @_;
if ( $self->{'comma'} eq 'start' and $token eq ',' ) {
return 0;
}
return ( $token =~ /^[,;.\[\]]$/ );
}
=head2 _generate_anonymized_string
Simply generate a random string, thanks to Perlmonks.
Returns original in certain cases which don't require anonymization, like
timestamps, or intervals.
=cut
sub _generate_anonymized_string {
my $self = shift;
my ( $before, $original, $after ) = @_;
# Prevent dates from being anonymized
return $original if $original =~ m{\A\d\d\d\d[/:-]\d\d[/:-]\d\d\z};
return $original if $original =~ m{\A\d\d[/:-]\d\d[/:-]\d\d\d\d\z};
# Prevent dates format like DD/MM/YYYY HH24:MI:SS from being anonymized
return $original if $original =~ m{
\A
(?:FM|FX|TM)?
(?:
HH | HH12 | HH24
| MI
| SS
| MS
| US
| SSSS
| AM | A\.M\. | am | a\.m\.
| PM | P\.M\. | pm | p\.m\.
| Y,YYY | YYYY | YYY | YY | Y
| IYYY | IYY | IY | I
| BC | B\.C\. | bc | b\.c\.
| AD | A\.D\. | ad | a\.d\.
| MONTH | Month | month | MON | Mon | mon | MM
| DAY | Day | day | DY | Dy | dy | DDD | DD | D
| W | WW | IW
| CC
| J
| Q
| RM | rm
| TZ | tz
| [\s/:-]
)+
(?:TH|th|SP)?
\z
};
# Prevent interval from being anonymized
return $original if ( $before && ( $before =~ /interval/i ) );
return $original if ( $after && ( $after =~ /^\)*::interval/i ) );
# Shortcut
my $cache = $self->{'_anonymization_cache'};
# Range of characters to use in anonymized strings
my @chars = ( 'A' .. 'Z', 0 .. 9, 'a' .. 'z', '-', '_', '.' );
unless ( $cache->{$original} ) {
# Actual anonymized version generation
$cache->{$original} = join( '', map { $chars[ rand @chars ] } 1 .. 10 );
}
return $cache->{$original};
}
=head2 anonymize
Anonymize litteral in SQL queries by replacing parameters with fake values
=cut
sub anonymize {
my $self = shift;
my $query = $self->{'query'};
# just in case it has not been called in the main script
$query = $self->query() if ( !$query );
return if ( !$query );
# Variable to hold anonymized versions, so we can provide the same value
# for the same input, within single query.
$self->{'_anonymization_cache'} = {};
# Remove comments
$query =~ s/\/\*(.*?)\*\///gs;
# Clean query
$query =~ s/\\'//gs;
$query =~ s/('')+/\$EMPTYSTRING\$/gs;
# Anonymize each values
$query =~ s{
([^\s\']+[\s\(]*) # before
'([^']*)' # original
([\)]*::\w+)? # after
}{$1 . "'" . $self->_generate_anonymized_string($1, $2, $3) . "'" . ($3||'')}xeg;
$query =~ s/\$EMPTYSTRING\$/''/gs;
foreach my $k ( keys %{ $self->{'keyword_constant'} } ) {
$self->{'keyword_constant'}{$k} = "'"
. $self->_generate_anonymized_string( '',
$self->{'keyword_constant'}{$k}, '' )
. "'";
}
$self->query($query);
}
=head2 set_defaults
Sets defaults for newly created objects.
Currently defined defaults:
=over
=item spaces => 4
=item space => ' '
=item break => "\n"
=item uc_keywords => 2
=item uc_functions => 0
=item uc_types => 1
=item no_comments => 0
=item no_grouping => 0
=item placeholder => ''
=item multiline => 0
=item separator => ''
=item comma => 'end'
=item format => 'text'
=item colorize => 1
=item format_type => 0
=item wrap_limit => 0
=item wrap_after => 0
=item wrap_comment => 0
=item no_extra_line => 0
=item keep_newline => 0
=item no_space_function => 0
=item redundant_parenthesis => 0
=back
=cut
sub set_defaults {
my $self = shift;
$self->set_dicts();
# Set some defaults.
$self->{'query'} = '';
$self->{'spaces'} = 4;
$self->{'space'} = ' ';
$self->{'break'} = "\n";
$self->{'wrap'} = {};
$self->{'rules'} = {};
$self->{'uc_keywords'} = 2;
$self->{'uc_functions'} = 0;
$self->{'uc_types'} = 1;
$self->{'no_comments'} = 0;
$self->{'no_grouping'} = 0;
$self->{'placeholder'} = '';
$self->{'multiline'} = 0;
$self->{'keywords'} = $self->{'dict'}->{'pg_keywords'};
$self->{'types'} = $self->{'dict'}->{'pg_types'};
$self->{'functions'} = ();
push(
@{ $self->{'functions'} },
keys %{ $self->{'dict'}->{'pg_functions'} }
);
$self->_refresh_functions_re();
$self->{'separator'} = '';
$self->{'comma'} = 'end';
$self->{'format'} = 'text';
$self->{'colorize'} = 1;
$self->{'format_type'} = 0;
$self->{'wrap_limit'} = 0;
$self->{'wrap_after'} = 0;
$self->{'wrap_comment'} = 0;
$self->{'no_extra_line'} = 0;
$self->{'keep_newline'} = 0;
$self->{'no_space_function'} = 0;
$self->{'redundant_parenthesis'} = 0;
return;
}
=head2 format
Set output format - possible values: 'text' and 'html'
Default is text output. Returns 0 in case or wrong format and use default.
=cut
sub format {
my $self = shift;
my $format = shift;
if ( grep( /^$format$/i, 'text', 'html' ) ) {
$self->{'format'} = lc($format);
return 1;
}
return 0;
}
=head2 set_dicts
Sets various dictionaries (lists of keywords, functions, symbols, and the like)
This was moved to separate function, so it can be put at the very end of module
so it will be easier to read the rest of the code.
=cut
sub set_dicts {
my $self = shift;
# First load it all as "my" variables, to make it simpler to modify/map/grep/add
# Afterwards, when everything is ready, put it in $self->{'dict'}->{...}
my @pg_keywords = map { uc } qw(
ADD AFTER AGGREGATE ALL ALSO ALTER ALWAYS ANALYSE ANALYZE AND ANY ARRAY AS ASC ASYMMETRIC ATOMIC AUTHORIZATION ATTACH AUTO_INCREMENT
BACKWARD BEFORE BEGIN BERNOULLI BETWEEN BINARY BOTH BY CACHE CASCADE CASE CAST CHECK CHECKPOINT CLOSE CLUSTER
COLLATE COLLATION COLUMN COMMENT COMMIT COMMITTED CONCURRENTLY CONFLICT CONSTRAINT CONSTRAINT CONTINUE COPY
COST COSTS CREATE CROSS CUBE CURRENT CURRENT_DATE CURRENT_ROLE CURRENT_TIME CURRENT_TIMESTAMP CURRENT_USER CURSOR
CYCLE DATABASE DEALLOCATE DECLARE DEFAULT DEFERRABLE DEFERRED DEFINER DELETE DELIMITER DESC DETACH DISABLE DISTINCT
DO DOMAIN DROP EACH ELSE ELSIF ENABLE ENCODING END EVENT EXCEPTION EXCEPT EXCLUDE EXCLUDING EXECUTE EXISTS EXPLAIN EXTENSION FALSE FETCH FILTER
FIRST FOLLOWING FOR FOREIGN FORWARD FREEZE FROM FULL FUNCTION GENERATED GRANT GROUP GROUPING HAVING HASHES HASH
IDENTITY IF ILIKE IMMUTABLE IN INCLUDING INCREMENT INDEX INHERITS INITIALLY INNER INOUT INSERT INSTEAD
INTERSECT INTO INVOKER IS ISNULL ISOLATION JOIN KEY LANGUAGE LAST LATERAL LC_COLLATE LC_CTYPE LEADING
LEAKPROOF LEFT LEFTARG LEVEL LEXIZE LIKE LIMIT LIST LISTEN LOAD LOCALTIME LOCALTIMESTAMP LOCK LOCKED LOGGED LOGIN
LOOP MAPPING MATCH MAXVALUE MERGES MINVALUE MODULUS MOVE NATURAL NEXT NOTHING NOTICE ORDINALITY
NO NOCREATEDB NOCREATEROLE NOSUPERUSER NOT NOTIFY NOTNULL NOWAIT NULL OFFSET OFF OF OIDS ON ONLY OPEN OPERATOR OR ORDER
OUTER OVER OVERLAPS OWNER PARTITION PASSWORD PERFORM PLACING POLICY PRECEDING PREPARE PRIMARY PROCEDURE RANGE
REASSIGN RECURSIVE REFERENCES REINDEX REMAINDER RENAME REPEATABLE REPLACE REPLICA RESET RESTART RESTRICT RETURN RETURNING
RETURNS REVOKE RIGHT RIGHTARG ROLE ROLLBACK ROLLUP ROWS ROW RULE SAVEPOINT SCHEMA SCROLL SECURITY SELECT SEQUENCE
SEQUENCE SERIALIZABLE SERVER SESSION_USER SET SETOF SETS SHOW SIMILAR SKIP SNAPSHOT SOME STABLE START STRICT
SYMMETRIC SYSTEM TABLE TABLESAMPLE TABLESPACE TEMPLATE TEMPORARY THEN TO TRAILING TRANSACTION TRIGGER TRUE
TRUNCATE TYPE UNBOUNDED UNCOMMITTED UNION UNIQUE UNLISTEN UNLOCK UNLOGGED UPDATE USER USING VACUUM VALUES
VARIADIC VERBOSE VIEW VOLATILE WHEN WHERE WINDOW WITH WITHIN WORK XOR ZEROFILL
CALL GROUPS INCLUDE OTHERS PROCEDURES ROUTINE ROUTINES TIES READ_ONLY SHAREABLE READ_WRITE
BASETYPE SFUNC STYPE SFUNC1 STYPE1 SSPACE FINALFUNC FINALFUNC_EXTRA FINALFUNC_MODIFY COMBINEFUNC SERIALFUNC DESERIALFUNC
INITCOND MSFUNC MINVFUNC MSTYPE MSSPACE MFINALFUNC MFINALFUNC_EXTRA MFINALFUNC_MODIFY MINITCOND SORTOP
STORED REFRESH MATERIALIZED RAISE WITHOUT
);
my @pg_types = qw(
BIGINT BIGSERIAL BIT BOOLEAN BOOL BOX BYTEA CHARACTER CHAR CIDR CIRCLE DATE DOUBLE INET INTEGER INTERVAL
JSONB JSON LINE LSEG MACADDR8 MACADDR MONEY NUMERIC OID PG_LSN POINT POLYGON PRECISION REAL SMALLINT SMALLSERIAL
SERIAL TEXT TIMESTAMPTZ TIMESTAMP TSQUERY TSVECTOR TXID_SNAPSHOT UUID XML VARYING VARCHAR ZONE FLOAT4
FLOAT8 FLOAT NAME TID INT4RANGE INT8RANGE NUMRANGE TSRANGE TSTZRANGE DATERANGE INT2 INT4 INT8 INT TIME
REGCLASS REGCONFIG REGDICTIONARY REGNAMESPACE REGOPER REGOPERATOR REGPROC REGPROCEDURE REGROLE REGTYPE
);
my @sql_keywords = map { uc } qw(
ABORT ABSOLUTE ACCESS ACTION ADMIN ALSO ALWAYS ASSERTION ASSIGNMENT AT ATTRIBUTE BIGINT BOOLEAN
CALLED CASCADED CATALOG CHAIN CHANGE CHARACTER CHARACTERISTICS COLUMNS COMMENTS CONFIGURATION
CONNECTION CONSTRAINTS CONTENT CONVERSION CSV CURRENT DATA DATABASES DAY DEC DECIMAL DEFAULTS DELAYED
DELIMITERS DESCRIBE DICTIONARY DISABLE DISCARD DOCUMENT DOUBLE ENABLE ENCLOSED ENCRYPTED ENUM ESCAPE ESCAPED
EXCLUSIVE EXTERNAL FIELD FIELDS FLOAT FLUSH FOLLOWING FORCE FUNCTIONS GLOBAL GRANTED GREATEST HANDLER
HEADER HOLD HOUR IDENTIFIED IGNORE IMMEDIATE IMPLICIT INDEXES INFILE INHERIT INLINE INPUT INSENSITIVE
INT INTEGER KEYS KILL LABEL LARGE LEAST LEVEL LINES LOCAL LOW_PRIORITY MATCH MINUTE MODE MODIFY MONTH NAMES
NATIONAL NCHAR NONE NOTHING NULLIF NULLS OBJECT OFF OPERATOR OPTIMIZE OPTION OPTIONALLY OPTIONS OUT OUTFILE
OWNED PARSER PARTIAL PASSING PLANS PRECISION PREPARED PRESERVE PRIOR PRIVILEGES PROCEDURAL QUOTE READ
REAL RECHECK REF REGEXP RELATIVE RELEASE RLIKE ROW SEARCH SECOND SEQUENCES SESSION SHARE SIMPLE
SMALLINT SONAME STANDALONE STATEMENT STATISTICS STATUS STORAGE STRAIGHT_JOIN SYSID TABLES TEMP TERMINATED
TREAT TRUSTED TYPES UNENCRYPTED UNKNOWN UNSIGNED UNTIL USE VALID VALIDATE VALIDATOR VALUE VARIABLES VARYING
WHITESPACE WORK WRAPPER WRITE XMLATTRIBUTES YEAR YES ZONE
);
my @redshift_keywords = map { uc } qw(
AES128 AES256 ALLOWOVERWRITE BACKUP BLANKSASNULL BYTEDICT BZIP2 CREDENTIALS CURRENT_USER_ID DEFLATE DEFRAG
DELTA DELTA32K DISABLE DISTKEY EMPTYASNULL ENABLE ENCODE ENCRYPT ENCRYPTION ESCAPE EXPLICIT GLOBALDICT256
GLOBALDICT64K GZIP INTERLEAVED LUN LUNS LZO LZOP MINUS MOSTLY13 MOSTLY32 MOSTLY8 NEW OFFLINE OFFSET OLD OID
PARALLEL PERCENT PERMISSIONS RAW READRATIO RECOVER REJECTLOG RESORT RESPECT RESTORE SORTKEY SYSDATE TAG TDES
TEXT255 TEXT32K TIMESTAMP TOP TRUNCATECOLUMNS UNLOAD WALLET ADDQUOTES
);
for my $k (@pg_keywords) {
next if grep { $k eq $_ } @sql_keywords;
push @sql_keywords, $k;
}
my @pg_functions = map { lc } qw(
ascii age bit_length btrim cardinality cast char_length character_length coalesce
brin_summarize_range brin_summarize_new_values
convert chr current_date current_time current_timestamp count decode date_part date_trunc
encode extract get_byte get_bit initcap isfinite interval justify_hours justify_days
lower length lpad ltrim localtime localtimestamp md5 now octet_length overlay position pg_client_encoding
quote_ident quote_literal repeat replace rpad rtrim substring split_part strpos substr set_byte set_bit
trim to_ascii to_hex translate to_char to_date to_timestamp to_number timeofday upper
abbrev abs abstime abstimeeq abstimege abstimegt abstimein abstimele
abstimelt abstimene abstimeout abstimerecv abstimesend aclcontains acldefault
aclexplode aclinsert aclitemeq aclitemin aclitemout aclremove acos
any_in any_out anyarray_in anyarray_out anyarray_recv anyarray_send anyelement_in
anyelement_out anyenum_in anyenum_out anynonarray_in anynonarray_out anyrange_in anyrange_out
anytextcat area areajoinsel areasel armor array_agg array_agg_finalfn
array_agg_transfn array_append array_cat array_dims array_eq array_fill array_ge array_positions
array_gt array_in array_larger array_le array_length array_lower array_lt array_position
array_ndims array_ne array_out array_prepend array_recv array_remove array_replace array_send array_smaller
array_to_json array_to_string array_typanalyze array_upper arraycontained arraycontains arraycontjoinsel
arraycontsel arrayoverlap ascii_to_mic ascii_to_utf8 asin atan atan2
avg big5_to_euc_tw big5_to_mic big5_to_utf8 bit bit_and bit_in
bit_or bit_out bit_recv bit_send bitand bitcat bitcmp
biteq bitge bitgt bitle bitlt bitne bitnot
bitor bitshiftleft bitshiftright bittypmodin bittypmodout bitxor bool
bool_and bool_or booland_statefunc boolean booleq boolge boolgt boolin
boolle boollt boolne boolor_statefunc boolout boolrecv boolsend
box box_above box_above_eq box_add box_below box_below_eq box_center
box_contain box_contain_pt box_contained box_distance box_div box_eq box_ge
box_gt box_in box_intersect box_le box_left box_lt box_mul
box_out box_overabove box_overbelow box_overlap box_overleft box_overright box_recv
box_right box_same box_send box_sub bpchar bpchar_larger bpchar_pattern_ge
bpchar_pattern_gt bpchar_pattern_le bpchar_pattern_lt bpchar_smaller bpcharcmp bpchareq bpcharge
bpchargt bpchariclike bpcharicnlike bpcharicregexeq bpcharicregexne bpcharin bpcharle
bpcharlike bpcharlt bpcharne bpcharnlike bpcharout bpcharrecv bpcharregexeq
bpcharregexne bpcharsend bpchartypmodin bpchartypmodout broadcast btabstimecmp btarraycmp
btbeginscan btboolcmp btbpchar_pattern_cmp btbuild btbuildempty btbulkdelete btcanreturn
btcharcmp btcostestimate btendscan btfloat48cmp btfloat4cmp btfloat4sortsupport btfloat84cmp
btfloat8cmp btfloat8sortsupport btgetbitmap btgettuple btinsert btint24cmp btint28cmp
btint2cmp btint2sortsupport btint42cmp btint48cmp btint4cmp btint4sortsupport btint82cmp
btint84cmp btint8cmp btint8sortsupport btmarkpos btnamecmp btnamesortsupport btoidcmp
btoidsortsupport btoidvectorcmp btoptions btrecordcmp btreltimecmp btrescan btrestrpos
bttext_pattern_cmp bttextcmp bttidcmp bttintervalcmp btvacuumcleanup bytea_string_agg_finalfn
bytea_string_agg_transfn byteacat byteacmp byteaeq byteage byteagt byteain byteale
bytealike bytealt byteane byteanlike byteaout bytearecv byteasend
cash_cmp cash_div_cash cash_div_flt4 cash_div_flt8 cash_div_int2 cash_div_int4 cash_eq
cash_ge cash_gt cash_in cash_le cash_lt cash_mi cash_mul_flt4
cash_mul_flt8 cash_mul_int2 cash_mul_int4 cash_ne cash_out cash_pl cash_recv
cash_send cash_words cashlarger cashsmaller cbrt ceil ceiling
center char chareq charge chargt charin charle
charlt charne charout charrecv charsend cideq cidin
cidout cidr cidr_in cidr_out cidr_recv cidr_send cidrecv
cidsend circle circle_above circle_add_pt circle_below circle_center circle_contain
circle_contain_pt circle_contained circle_distance circle_div_pt circle_eq circle_ge circle_gt
circle_in circle_le circle_left circle_lt circle_mul_pt circle_ne circle_out
circle_overabove circle_overbelow circle_overlap circle_overleft circle_overright circle_recv circle_right
circle_same circle_send circle_sub_pt clock_timestamp close_lb close_ls close_lseg
close_pb close_pl close_ps close_sb close_sl col_description concat
concat_ws contjoinsel contsel convert_from convert_to corr cos
cot covar_pop covar_samp crypt cstring_in cstring_out cstring_recv
cstring_send cume_dist current_database current_query current_schema current_schemas current_setting
current_user currtid currtid2 currval date date_cmp date_cmp_timestamp date_cmp_timestamptz date_eq
date_eq_timestamp date_eq_timestamptz date_ge date_ge_timestamp date_ge_timestamptz date_gt date_gt_timestamp
date_gt_timestamptz date_in date_larger date_le date_le_timestamp date_le_timestamptz date_lt
date_lt_timestamp date_lt_timestamptz date_mi date_mi_interval date_mii date_ne date_ne_timestamp
date_ne_timestamptz date_out date_pl_interval date_pli date_recv date_send date_smaller
date_sortsupport daterange daterange_canonical daterange_subdiff datetime_pl datetimetz_pl
dblink_connect_u dblink_connect dblink_disconnect dblink_exec dblink_open dblink_fetch dblink_close
dblink_get_connections dblink_error_message dblink_send_query dblink_is_busy dblink_get_notify
dblink_get_result dblink_cancel_query dblink_get_pkey dblink_build_sql_insert dblink_build_sql_delete
dblink_build_sql_update dblink dcbrt dearmor decrypt decrypt_iv degrees dense_rank dexp diagonal
decimal diameter digest dispell_init dispell_lexize dist_cpoly dist_lb dist_pb
dist_pc dist_pl dist_ppath dist_ps dist_sb dist_sl div
dlog1 dlog10 domain_in domain_recv dpow dround dsimple_init
dsimple_lexize dsnowball_init dsnowball_lexize dsqrt dsynonym_init dsynonym_lexize dtrunc
elem_contained_by_range encrypt encrypt_iv enum_cmp enum_eq enum_first enum_ge
enum_gt enum_in enum_larger enum_last enum_le enum_lt enum_ne
enum_out enum_range enum_recv enum_send enum_smaller eqjoinsel eqsel
euc_cn_to_mic euc_cn_to_utf8 euc_jis_2004_to_shift_jis_2004 euc_jis_2004_to_utf8
euc_jp_to_mic euc_jp_to_sjis euc_jp_to_utf8
euc_kr_to_mic euc_kr_to_utf8 euc_tw_to_big5 euc_tw_to_mic euc_tw_to_utf8 every exp
factorial family fdw_handler_in fdw_handler_out first_value float4 float48div
float48eq float48ge float48gt float48le float48lt float48mi float48mul
float48ne float48pl float4_accum float4abs float4div float4eq float4ge
float4gt float4in float4larger float4le float4lt float4mi float4mul
float4ne float4out float4pl float4recv float4send float4smaller float4um
float4up float8 float84div float84eq float84ge float84gt float84le
float84lt float84mi float84mul float84ne float84pl float8_accum float8_avg
float8_combine float8_regr_combine float8_corr float8_covar_pop float8_covar_samp
float8_regr_accum float8_regr_avgx float8_regr_avgy float8_regr_intercept
float8_regr_r2 float8_regr_slope float8_regr_sxx float8_regr_sxy float8_regr_syy
float8_stddev_pop float8_stddev_samp
float8_var_pop float8_var_samp float8abs float8div float8eq float8ge float8gt
float8in float8larger float8le float8lt float8mi float8mul float8ne
float8out float8pl float8recv float8send float8smaller float8um float8up
floor flt4_mul_cash flt8_mul_cash fmgr_c_validator fmgr_internal_validator fmgr_sql_validator format
format_type gb18030_to_utf8 gbk_to_utf8 gen_random_bytes gen_salt generate_series generate_subscripts
geometry get_current_ts_config getdatabaseencoding getpgusername gin_cmp_prefix gin_cmp_tslexeme
gin_extract_tsquery gin_extract_tsvector gin_tsquery_consistent ginarrayconsistent ginarrayextract
ginbeginscan ginbuild ginbuildempty ginbulkdelete gincostestimate ginendscan gingetbitmap gininsert
ginmarkpos ginoptions ginqueryarrayextract ginrescan ginrestrpos ginvacuumcleanup gist_box_compress
gist_box_consistent gist_box_decompress gist_box_penalty gist_box_picksplit gist_box_same gist_box_union
gist_circle_compress gist_circle_consistent gist_point_compress gist_point_consistent gist_point_distance
gist_poly_compress gist_poly_consistent gistbeginscan gistbuild gistbuildempty gistbulkdelete
gistcostestimate gistendscan gistgetbitmap gistgettuple gistinsert gistmarkpos gistoptions gistrescan
gistrestrpos gistvacuumcleanup group_concat gtsquery_compress gtsquery_consistent gtsquery_decompress gtsquery_penalty
gtsquery_picksplit gtsquery_same gtsquery_union gtsvector_compress gtsvector_consistent gtsvector_decompress
gtsvector_penalty gtsvector_picksplit gtsvector_same gtsvector_union gtsvectorin gtsvectorout
has_any_column_privilege has_column_privilege has_database_privilege has_foreign_data_wrapper_privilege
has_function_privilege has_language_privilege has_schema_privilege has_sequence_privilege has_server_privilege
has_table_privilege has_tablespace_privilege has_type_privilege hash_aclitem hash_array hash_numeric hash_range
hashbeginscan hashbpchar hashbuild hashbuildempty hashbulkdelete hashchar hashcostestimate hash_aclitem_extended
hashendscan hashenum hashfloat4 hashfloat8 hashgetbitmap hashgettuple hashinet hashinsert hashint2
hashint2extended hashint2vector hashint4 hashint4extended hashint8 hashint8extended hashmacaddr
hashfloat4extended hashfloat8extended hashcharextended hashoidextended hashnameextended hashmarkpos
hashoidvectorextended hashmacaddrextended hashinetextended hashname hashoid hashoidvector hashoptions
hash_numeric_extended hashmacaddr8extended hash_array_extended hashrescan hashrestrpos hashtext
hashbpcharextended time_hash_extended timetz_hash_extended interval_hash_extended timestamp_hash_extended
uuid_hash_extended pg_lsn_hash_extended hashenumextended jsonb_hash_extended hash_range_extended
hashtextextended hashvacuumcleanup hashvarlena height hmac host hostmask iclikejoinsel
iclikesel icnlikejoinsel icnlikesel icregexeqjoinsel icregexeqsel icregexnejoinsel icregexnesel
inet_client_addr inet_client_port inet_in inet_out inet_recv inet_send inet_server_addr
inet_server_port inetand inetmi inetmi_int8 inetnot inetor inetpl
int int2 int24div int24eq int24ge int24gt int24le int24lt integer
int24mi int24mul int24ne int24pl int28div int28eq int28ge
int28gt int28le int28lt int28mi int28mul int28ne int28pl
int2_accum int2_avg_accum int2_mul_cash int2_sum int2abs int2and int2div
int2eq int2ge int2gt int2in int2larger int2le int2lt
int2mi int2mod int2mul int2ne int2not int2or int2out
int2pl int2recv int2send int2shl int2shr int2smaller int2um
int2up int2vectoreq int2vectorin int2vectorout int2vectorrecv int2vectorsend int2xor
int4 int42div int42eq int42ge int42gt int42le int42lt
int42mi int42mul int42ne int42pl int48div int48eq int48ge
int48gt int48le int48lt int48mi int48mul int48ne int48pl
int4_accum int4_avg_accum int4_mul_cash int4_sum int4abs int4and int4div
int4eq int4ge int4gt int4in int4inc int4larger int4le
int4lt int4mi int4mod int4mul int4ne int4not int4or
int4out int4pl int4range int4range_canonical int4range_subdiff int4recv int4send
int4shl int4shr int4smaller int4um int4up int4xor int8
int82div int82eq int82ge int82gt int82le int82lt int82mi
int82mul int82ne int82pl int84div int84eq int84ge int84gt
int84le int84lt int84mi int84mul int84ne int84pl int8_accum
int8_avg int8_avg_accum int8_sum int8abs int8and int8div int8eq
int8ge int8gt int8in int8inc int8inc_any int8inc_float8_float8 int8larger
int8le int8lt int8mi int8mod int8mul int8ne int8not
int8or int8out int8pl int8pl_inet int8range int8range_canonical int8range_subdiff
int8recv int8send int8shl int8shr int8smaller int8um int8up
int8xor integer_pl_date inter_lb inter_sb inter_sl internal_in internal_out
interval_accum interval_avg interval_cmp interval_div interval_eq interval_ge interval_gt
interval_hash interval_in interval_larger interval_le interval_lt interval_mi interval_mul
interval_ne interval_out interval_pl interval_pl_date interval_pl_time interval_pl_timestamp interval_pl_timestamptz
interval_pl_timetz interval_recv interval_send interval_smaller interval_transform interval_um intervaltypmodin
intervaltypmodout intinterval isclosed isempty ishorizontal iso8859_1_to_utf8 iso8859_to_utf8
iso_to_koi8r iso_to_mic iso_to_win1251 iso_to_win866 isopen isparallel isperp
isvertical johab_to_utf8 json_agg jsonb_agg json_array_elements jsonb_array_elements
json_array_elements_text jsonb_array_elements_text json_to_tsvector jsonb_insert
json_array_length jsonb_array_length json_build_array json_build_object json_each jsonb_each json_each_text
jsonb_each_text json_extract_path jsonb_extract_path json_extract_path_text jsonb_extract_path_text json_in
json_object json_object_agg jsonb_object_agg json_object_keys jsonb_object_keys json_out json_populate_record
jsonb_populate_record json_populate_recordset jsonb_pretty jsonb_populate_recordset json_recv json_send
jsonb_set json_typeof jsonb_typeof json_to_record jsonb_to_record json_to_recordset jsonb_to_recordset
justify_interval koi8r_to_iso koi8r_to_mic koi8r_to_utf8 koi8r_to_win1251 koi8r_to_win866 koi8u_to_utf8
jsonb_path_query jsonb_build_object jsonb_object jsonb_build_array jsonb_path_match jsonb_path_exists
lag language_handler_in language_handler_out last_value lastval latin1_to_mic latin2_to_mic latin2_to_win1250
latin3_to_mic latin4_to_mic lead like_escape likejoinsel jsonb_path_query_first jsonb_path_query_array
likesel line line_distance line_eq line_horizontal line_in line_interpt
line_intersect line_out line_parallel line_perp line_recv line_send line_vertical
ln lo_close lo_creat lo_create lo_export lo_import lo_lseek lo_compat lo_from_bytea lo_get lo_import_with_oid
lo_open lo_tell lo_truncate lo_unlink log lo_read lower_inc lo_seek64 lo_put lo_tell64 lo_truncate64 lo_write
lower_inf lowrite lseg lseg_center lseg_distance lseg_eq lseg_ge
lseg_gt lseg_horizontal lseg_in lseg_interpt lseg_intersect lseg_le lseg_length
lseg_lt lseg_ne lseg_out lseg_parallel lseg_perp lseg_recv lseg_send
lseg_vertical macaddr_and macaddr_cmp macaddr_eq macaddr_ge macaddr_gt macaddr_in
macaddr_le macaddr_lt macaddr_ne macaddr_not macaddr_or macaddr_out macaddr_recv
macaddr_send makeaclitem make_interval make_tsrange masklen max mic_to_ascii mic_to_big5 mic_to_euc_cn
mic_to_euc_jp mic_to_euc_kr mic_to_euc_tw mic_to_iso mic_to_koi8r mic_to_latin1 mic_to_latin2
mic_to_latin3 mic_to_latin4 mic_to_sjis mic_to_win1250 mic_to_win1251 mic_to_win866 min
mktinterval mode mod money mul_d_interval name nameeq namege make_timestamptz make_timestamp
namegt nameiclike nameicnlike nameicregexeq nameicregexne namein namele make_time make_date
namelike namelt namene namenlike nameout namerecv nameregexeq make_interval
nameregexne namesend neqjoinsel neqsel netmask network network_cmp
network_eq network_ge network_gt network_le network_lt network_ne network_sub
network_subeq network_sup network_supeq nextval nlikejoinsel nlikesel notlike
npoints nth_value ntile numeric numeric_abs numeric_accum numeric_add
numeric_avg numeric_avg_accum numeric_cmp numeric_div numeric_div_trunc numeric_eq numeric_exp
numeric_fac numeric_ge numeric_gt numeric_in numeric_inc numeric_larger numeric_le
numeric_ln numeric_log numeric_lt numeric_mod numeric_mul numeric_ne numeric_out
numeric_power numeric_recv numeric_send numeric_smaller numeric_sqrt numeric_stddev_pop numeric_stddev_samp
numeric_sub numeric_transform numeric_uminus numeric_uplus numeric_var_pop numeric_var_samp numerictypmodin
numerictypmodout numnode numrange numrange_subdiff obj_description oid oideq
oidge oidgt oidin oidlarger oidle oidlt oidne
oidout oidrecv oidsend oidsmaller oidvectoreq oidvectorge oidvectorgt
oidvectorin oidvectorle oidvectorlt oidvectorne oidvectorout oidvectorrecv oidvectorsend
oidvectortypes on_pb on_pl on_ppath on_ps on_sb on_sl
opaque_in opaque_out overlaps path path_add path_add_pt path_center
path_contain_pt path_distance path_div_pt path_in path_inter path_length path_mul_pt
path_n_eq path_n_ge path_n_gt path_n_le path_n_lt path_npoints path_out parse_ident
path_recv path_send path_sub_pt pclose percent_rank percentile_cont percentile_disc
pg_advisory_lock pg_advisory_lock_shared pg_advisory_unlock pg_advisory_unlock_all pg_advisory_unlock_shared
pg_advisory_xact_lock pg_advisory_xact_lock_shared pg_available_extension_versions pg_available_extensions
pg_backend_pid pg_cancel_backend pg_char_to_encoding pg_collation_for pg_collation_is_visible pg_column_size
pg_conf_load_time pg_conversion_is_visible pg_create_restore_point pg_current_xlog_insert_location
pg_current_xlog_location pg_cursor pg_database_size pg_describe_object pg_encoding_max_length
pg_encoding_to_char pg_export_snapshot pg_extension_config_dump pg_extension_update_paths pg_function_is_visible
pg_get_constraintdef pg_get_expr pg_get_function_arguments pg_filenode_relation pg_indexam_has_property
pg_get_function_identity_arguments pg_get_function_result pg_get_functiondef pg_get_indexdef pg_get_keywords
pg_get_ruledef pg_get_serial_sequence pg_get_triggerdef pg_get_userbyid pg_get_viewdef pg_has_role
pg_indexes_size pg_is_in_recovery pg_is_other_temp_schema pg_is_xlog_replay_paused pg_last_xact_replay_timestamp
pg_last_xlog_receive_location pg_last_xlog_replay_location pg_listening_channels pg_lock_status pg_ls_dir
pg_my_temp_schema pg_node_tree_in pg_node_tree_out pg_node_tree_recv pg_node_tree_send pg_notify
pg_opclass_is_visible pg_operator_is_visible pg_opfamily_is_visible pg_options_to_table pg_index_has_property
pg_postmaster_start_time pg_prepared_statement pg_prepared_xact pg_read_binary_file pg_read_file
pg_relation_filenode pg_relation_filepath pg_relation_size pg_reload_conf pg_rotate_logfile
pg_sequence_parameters pg_show_all_settings pg_size_pretty pg_sleep pg_start_backup pg_index_column_has_property
pg_stat_clear_snapshot pg_stat_file pg_stat_get_activity pg_stat_get_analyze_count pg_stat_get_autoanalyze_count
pg_stat_get_autovacuum_count pg_get_object_address pg_identify_object_as_address pg_stat_get_backend_activity
pg_stat_get_backend_activity_start pg_stat_get_backend_client_addr pg_stat_get_backend_client_port
pg_stat_get_backend_dbid pg_stat_get_backend_idset pg_stat_get_backend_pid pg_stat_get_backend_start
pg_stat_get_backend_userid pg_stat_get_backend_waiting pg_stat_get_backend_xact_start
pg_stat_get_bgwriter_buf_written_checkpoints pg_stat_get_bgwriter_buf_written_clean
pg_stat_get_bgwriter_maxwritten_clean pg_stat_get_bgwriter_requested_checkpoints
pg_stat_get_bgwriter_stat_reset_time pg_stat_get_bgwriter_timed_checkpoints pg_stat_get_blocks_fetched
pg_stat_get_blocks_hit pg_stat_get_buf_alloc pg_stat_get_buf_fsync_backend pg_stat_get_buf_written_backend
pg_stat_get_checkpoint_sync_time pg_stat_get_checkpoint_write_time pg_stat_get_db_blk_read_time
pg_stat_get_db_blk_write_time pg_stat_get_db_blocks_fetched pg_stat_get_db_blocks_hit
pg_stat_get_db_conflict_all pg_stat_get_db_conflict_bufferpin pg_stat_get_db_conflict_lock
pg_stat_get_db_conflict_snapshot pg_stat_get_db_conflict_startup_deadlock pg_stat_get_db_conflict_tablespace
pg_stat_get_db_deadlocks pg_stat_get_db_numbackends pg_stat_get_db_stat_reset_time pg_stat_get_db_temp_bytes
pg_stat_get_db_temp_files pg_stat_get_db_tuples_deleted pg_stat_get_db_tuples_fetched
pg_stat_get_db_tuples_inserted pg_stat_get_db_tuples_returned pg_stat_get_db_tuples_updated
pg_stat_get_db_xact_commit pg_stat_get_db_xact_rollback pg_stat_get_dead_tuples pg_stat_get_function_calls
pg_stat_get_function_self_time pg_stat_get_function_total_time pg_stat_get_last_analyze_time
pg_stat_get_last_autoanalyze_time pg_stat_get_last_autovacuum_time pg_stat_get_last_vacuum_time
pg_stat_get_live_tuples pg_stat_get_numscans pg_stat_get_tuples_deleted pg_stat_get_tuples_fetched
pg_stat_get_tuples_hot_updated pg_stat_get_tuples_inserted pg_stat_get_tuples_returned
pg_stat_get_tuples_updated pg_stat_get_vacuum_count pg_stat_get_wal_senders pg_stat_get_xact_blocks_fetched
pg_stat_get_xact_blocks_hit pg_stat_get_xact_function_calls pg_stat_get_xact_function_self_time
pg_stat_get_xact_function_total_time pg_stat_get_xact_numscans pg_stat_get_xact_tuples_deleted
pg_stat_get_xact_tuples_fetched pg_stat_get_xact_tuples_hot_updated pg_stat_get_xact_tuples_inserted
pg_stat_get_xact_tuples_returned pg_stat_get_xact_tuples_updated pg_stat_reset pg_stat_reset_shared
pg_stat_reset_single_function_counters pg_stat_reset_single_table_counters pg_stop_backup pg_switch_xlog
pg_table_is_visible pg_table_size pg_tablespace_databases pg_tablespace_location pg_tablespace_size
pg_terminate_backend pg_timezone_abbrevs pg_timezone_names pg_total_relation_size pg_trigger_depth
pg_try_advisory_lock pg_try_advisory_lock_shared pg_try_advisory_xact_lock pg_try_advisory_xact_lock_shared
pg_ts_config_is_visible pg_ts_dict_is_visible pg_ts_parser_is_visible pg_ts_template_is_visible
pg_type_is_visible pg_typeof pg_xact_commit_timestamp pg_last_committed_xact pg_xlog_location_diff
pg_xlog_replay_pause pg_xlog_replay_resume pg_xlogfile_name pg_xlogfile_name_offset pgp_key_id pgp_pub_decrypt
pgp_pub_decrypt_bytea pgp_pub_encrypt pgp_pub_encrypt_bytea pgp_sym_decrypt pgp_sym_decrypt_bytea
pgp_sym_encrypt pgp_sym_encrypt_bytea pi plainto_tsquery plpgsql_call_handler plpgsql_inline_handler
plpgsql_validator point point_above point_add point_below point_distance point_div point_eq
point_horiz point_in point_left point_mul point_ne point_out point_recv
point_right point_send point_sub point_vert poly_above poly_below poly_center
poly_contain poly_contain_pt poly_contained poly_distance poly_in poly_left poly_npoints
poly_out poly_overabove poly_overbelow poly_overlap poly_overleft poly_overright poly_recv
poly_right poly_same poly_send polygon popen positionjoinsel positionsel
postgresql_fdw_validator pow power prsd_end prsd_headline prsd_lextype prsd_nexttoken
prsd_start pt_contained_circle pt_contained_poly querytree
quote_nullable radians radius random range_adjacent range_after range_before
range_cmp range_contained_by range_contains range_contains_elem range_eq range_ge range_gist_compress
range_gist_consistent range_gist_decompress range_gist_penalty range_gist_picksplit range_gist_same
range_gist_union range_gt range_merge
range_in range_intersect range_le range_lt range_minus range_ne range_out
range_overlaps range_overleft range_overright range_recv range_send range_typanalyze range_union
rank record_eq record_ge record_gt record_in record_le record_lt regexp_match
record_ne record_out record_recv record_send regclass regclassin regclassout
regclassrecv regclasssend regconfigin regconfigout regconfigrecv regconfigsend regdictionaryin
regnamespace regoper regoperator regproc regprocedure regrole regtype regdictionaryout
regdictionaryrecv regdictionarysend regexeqjoinsel regexeqsel regexnejoinsel regexnesel regexp_matches
regexp_replace regexp_split_to_array regexp_split_to_table regoperatorin regoperatorout regoperatorrecv
regoperatorsend regoperin regoperout regoperrecv regopersend regprocedurein regprocedureout
regprocedurerecv regproceduresend regprocin regprocout regprocrecv regprocsend regr_avgx
regr_avgy regr_count regr_intercept regr_r2 regr_slope regr_sxx regr_sxy
regr_syy regtypein regtypeout regtyperecv regtypesend reltime reltimeeq
reltimege reltimegt reltimein reltimele reltimelt reltimene reltimeout
reltimerecv reltimesend reverse round row_number row_to_json
scalargtjoinsel scalargtsel scalarltjoinsel scalarltsel
session_user set_config set_masklen setseed setval setweight shell_in
shell_out shift_jis_2004_to_euc_jis_2004 shift_jis_2004_to_utf8 shobj_description sign similar_escape sin
sjis_to_euc_jp sjis_to_mic sjis_to_utf8 slope smgreq smgrin smgrne
smgrout spg_kd_choose spg_kd_config spg_kd_inner_consistent spg_kd_picksplit spg_quad_choose spg_quad_config
spg_quad_inner_consistent spg_quad_leaf_consistent spg_quad_picksplit spg_text_choose spg_text_config spg_text_inner_consistent spg_text_leaf_consistent
spg_text_picksplit spgbeginscan spgbuild spgbuildempty spgbulkdelete spgcanreturn spgcostestimate
spgendscan spggetbitmap spggettuple spginsert spgmarkpos spgoptions spgrescan
spgrestrpos spgvacuumcleanup sqrt statement_timestamp stddev stddev_pop stddev_samp
string_agg string_agg_finalfn string_agg_transfn string_to_array strip sum
tan text text_ge text_gt text_larger
text_le text_lt text_pattern_ge text_pattern_gt text_pattern_le text_pattern_lt text_smaller
textanycat textcat texteq texticlike texticnlike texticregexeq texticregexne
textin textlen textlike textne textnlike textout textrecv
textregexeq textregexne textsend thesaurus_init thesaurus_lexize tideq tidge
tidgt tidin tidlarger tidle tidlt tidne tidout
tidrecv tidsend tidsmaller time time_cmp time_eq time_ge
time_gt time_hash time_in time_larger time_le time_lt time_mi_interval
time_mi_time time_ne time_out time_pl_interval time_recv time_send time_smaller
time_transform timedate_pl timemi timenow timepl timestamp timestamp_cmp
timestamp_cmp_date timestamp_cmp_timestamptz timestamp_eq timestamp_eq_date timestamp_eq_timestamptz timestamp_ge timestamp_ge_date
timestamp_ge_timestamptz timestamp_gt timestamp_gt_date timestamp_gt_timestamptz timestamp_hash timestamp_in timestamp_larger
timestamp_le timestamp_le_date timestamp_le_timestamptz timestamp_lt timestamp_lt_date timestamp_lt_timestamptz timestamp_mi
timestamp_mi_interval timestamp_ne timestamp_ne_date timestamp_ne_timestamptz timestamp_out timestamp_pl_interval timestamp_recv
timestamp_send timestamp_smaller timestamp_sortsupport timestamp_transform timestamptypmodin timestamptypmodout timestamptz
timestamptz_cmp timestamptz_cmp_date timestamptz_cmp_timestamp timestamptz_eq timestamptz_eq_date timestamptz_eq_timestamp timestamptz_ge
timestamptz_ge_date timestamptz_ge_timestamp timestamptz_gt timestamptz_gt_date timestamptz_gt_timestamp timestamptz_in timestamptz_larger
timestamptz_le timestamptz_le_date timestamptz_le_timestamp timestamptz_lt timestamptz_lt_date timestamptz_lt_timestamp timestamptz_mi
timestamptz_mi_interval timestamptz_ne timestamptz_ne_date timestamptz_ne_timestamp timestamptz_out timestamptz_pl_interval timestamptz_recv
timestamptz_send timestamptz_smaller timestamptztypmodin timestamptztypmodout timetypmodin timetypmodout timetz
timetz_cmp timetz_eq timetz_ge timetz_gt timetz_hash timetz_in timetz_larger
timetz_le timetz_lt timetz_mi_interval timetz_ne timetz_out timetz_pl_interval timetz_recv
timetz_send timetz_smaller timetzdate_pl timetztypmodin timetztypmodout timezone tinterval
tintervalct tintervalend tintervaleq tintervalge tintervalgt tintervalin tintervalle
tintervalleneq tintervallenge tintervallengt tintervallenle tintervallenlt tintervallenne tintervallt
tintervalne tintervalout tintervalov tintervalrecv tintervalrel tintervalsame tintervalsend
tintervalstart to_json to_tsquery to_tsvector to_regclass to_regnamespace to_regoper to_regoperator
to_regproc to_regprocedure to_regrole to_regtype transaction_timestamp trigger_out trunc ts_debug
ts_headline ts_lexize ts_match_qv ts_match_tq ts_match_tt ts_match_vq ts_parse ts_delete ts_filter
ts_rank ts_rank_cd ts_rewrite ts_stat ts_token_type ts_typanalyze tsmatchjoinsel tsquery_phrase
tsmatchsel tsq_mcontained tsq_mcontains tsquery_and tsquery_cmp tsquery_eq tsquery_ge
tsquery_gt tsquery_le tsquery_lt tsquery_ne tsquery_not tsquery_or tsqueryin websearch_to_tsquery
tsqueryout tsqueryrecv tsquerysend tsrange tsrange_subdiff tstzrange tstzrange_subdiff phraseto_tsquery
tsvector_cmp tsvector_concat tsvector_eq tsvector_ge tsvector_gt tsvector_le tsvector_lt
tsvector_ne tsvectorin tsvectorout tsvectorrecv tsvectorsend txid_current txid_current_snapshot
txid_snapshot_in txid_snapshot_out txid_snapshot_recv txid_snapshot_send txid_snapshot_xip
txid_snapshot_xmax txid_snapshot_xmin
txid_visible_in_snapshot uhc_to_utf8 unknownin unknownout unknownrecv unknownsend unnest
upper_inc upper_inf utf8_to_ascii utf8_to_big5 utf8_to_euc_cn utf8_to_euc_jis_2004 utf8_to_euc_jp
utf8_to_euc_kr utf8_to_euc_tw utf8_to_gb18030 utf8_to_gbk utf8_to_iso8859 utf8_to_iso8859_1 utf8_to_johab
utf8_to_koi8r utf8_to_koi8u utf8_to_shift_jis_2004 utf8_to_sjis utf8_to_uhc utf8_to_win uuid_cmp
uuid_eq uuid_ge uuid_gt uuid_hash uuid_in uuid_le uuid_lt
uuid_ne uuid_out uuid_recv uuid_send var_pop var_samp varbit
varbit_in varbit_out varbit_recv varbit_send varbit_transform varbitcmp varbiteq
varbitge varbitgt varbitle varbitlt varbitne varbittypmodin varbittypmodout
varchar varying varchar_transform varcharin varcharout varcharrecv varcharsend varchartypmodin
varchartypmodout variance version void_in void_out void_recv void_send
width width_bucket win1250_to_latin2 win1250_to_mic win1251_to_iso win1251_to_koi8r win1251_to_mic
win1251_to_win866 win866_to_iso win866_to_koi8r win866_to_mic win866_to_win1251 win_to_utf8 xideq
xideqint4 xidin xidout xidrecv xidsend xml xml_in xmlcomment xpath xpath_exists table_to_xmlschema
query_to_xmlschema cursor_to_xmlschema table_to_xml_and_xmlschema query_to_xml_and_xmlschema
schema_to_xml schema_to_xmlschema schema_to_xml_and_xmlschema database_to_xml database_to_xmlschema xmlroot
database_to_xml_and_xmlschema table_to_xml query_to_xmlcursor_to_xml xmlcomment xmlconcat xmlelement xmlforest
xml_is_well_formed_content xml_is_well_formed_document xml_is_well_formed xml_out xml_recv xml_send xmlagg
xmlpi query_to_xml cursor_to_xml xmlserialize xmltable
);
my @copy_keywords = ( 'STDIN', 'STDOUT' );
my %symbols = (
'=' => '=',
'<' => '<',
'>' => '>',
'|' => '|',
',' => ',',
'.' => '.',
'+' => '+',
'-' => '-',
'*' => '*',
'/' => '/',
'!=' => '!=',
'%' => '%',
'<=' => '<=',
'>=' => '>=',
'<>' => '<>'
);
my @brackets = ( '(', ')' );
# All setting and modification of dicts is done, can set them now to $self->{'dict'}->{...}
$self->{'dict'}->{'pg_keywords'} = \@pg_keywords;
$self->{'dict'}->{'pg_types'} = \@pg_types;
$self->{'dict'}->{'sql_keywords'} = \@sql_keywords;
$self->{'dict'}->{'redshift_keywords'} = \@redshift_keywords;
$self->{'dict'}->{'pg_functions'} = ();
map { $self->{'dict'}->{'pg_functions'}{$_} = ''; } @pg_functions;
$self->{'dict'}->{'copy_keywords'} = \@copy_keywords;
$self->{'dict'}->{'symbols'} = \%symbols;
$self->{'dict'}->{'brackets'} = \@brackets;
return;
}
=head2 _remove_dynamic_code
Internal function used to hide dynamic code in plpgsql to the parser.
The original values are restored with function _restore_dynamic_code().
=cut
sub _remove_dynamic_code {
my ( $self, $str, $code_sep ) = @_;
my @dynsep = ();
push( @dynsep, $code_sep ) if ( $code_sep && $code_sep ne "'" );
# Try to auto detect the string separator if none are provided.
# Note that default single quote separtor is natively supported.
if ( $#dynsep == -1 ) {
# if a dollar sign is found after EXECUTE then the following string
# until an other dollar is found will be understand as a text delimiter
@dynsep = $$str =~ /EXECUTE\s+(\$[^\$\s]*\$)/igs;
}
foreach my $sep (@dynsep) {
while ( $$str =~ s/(\Q$sep\E.*?\Q$sep\E)/TEXTVALUE$self->{idx_code}/s )
{
$self->{dynamic_code}{ $self->{idx_code} } = $1;
$self->{idx_code}++;
}
}
# Replace any COMMENT constant between single quote
while ( $$str =~ s/IS\s+('(?:.*?)')\s*;/IS TEXTVALUE$self->{idx_code};/s ) {
$self->{dynamic_code}{ $self->{idx_code} } = $1;
$self->{idx_code}++;
}
# keep untouched parts between double single quotes
while ( $$str =~
s/(PGFESCQ1(?:[^\r\n\|;]*?)PGFESCQ1)/TEXTVALUE$self->{idx_code}/s )
{
$self->{dynamic_code}{ $self->{idx_code} } = $1;
$self->{idx_code}++;
}
}
=head2 _restore_dynamic_code
Internal function used to restore plpgsql dynamic code in plpgsql
that was removed by the _remove_dynamic_code() method.
=cut
sub _restore_dynamic_code {
my ( $self, $str ) = @_;
$$str =~ s/TEXTVALUE(\d+)/$self->{dynamic_code}{$1}/gs;
}
=head2 _quote_operator
Internal function used to quote operator with multiple character
to be tokenized as a single word.
The original values are restored with function _restore_operator().
=cut
sub _quote_operator {
my ( $self, $str ) = @_;
my @lines = split( /[\n]/, $$str );
for ( my $i = 0 ; $i <= $#lines ; $i++ ) {
if ( $lines[$i] =~
s/((?:CREATE|DROP|ALTER)\s+OPERATOR\s+(?:IF\s+EXISTS)?)\s*((:?[a-z0-9]+\.)?[\+\-\*\/<>=\~\!\@\#\%\^\&\|\`\?]+)\s*/$1 "$2" /i
)
{
push( @{ $self->{operator} }, $2 )
if ( !grep( /^\Q$2\E$/, @{ $self->{operator} } ) );
}
}
$$str = join( "\n", @lines );
my $idx = 0;
while ( $$str =~ s/(NEGATOR|COMMUTATOR)\s*=\s*([^,\)\s]+)/\U$1\E$idx/is ) {
$self->{ uc($1) }{$idx} = "$1 = $2";
$idx++;
}
}
=head2 _restore_operator
Internal function used to restore operator that was removed
by the _quote_operator() method.
=cut
sub _restore_operator {
my ( $self, $str ) = @_;
foreach my $op ( @{ $self->{operator} } ) {
$$str =~ s/"$op"/$op/gs;
}
if ( exists $self->{COMMUTATOR} ) {
$$str =~ s/COMMUTATOR(\d+)/$self->{COMMUTATOR}{$1}/igs;
}
if ( exists $self->{NEGATOR} ) {
$$str =~ s/NEGATOR(\d+)/$self->{NEGATOR}{$1}/igs;
}
}
=head2 _quote_comment_stmt
Internal function used to replace constant in a COMMENT statement
to be tokenized as a single word.
The original values are restored with function _restore_comment_stmt().
=cut
sub _quote_comment_stmt {
my ( $self, $str ) = @_;
my $idx = 0;
while ( $$str =~
s/(COMMENT\s+ON\s+(?:.*?)\s+IS)\s+(\$[^;]+?\$)\s*;/$1 PGF_CMTSTR$idx;/is
)
{
$self->{comment_str}{$idx} = $2;
$idx++;
}
}
=head2 _restore_comment_stmt
Internal function used to restore comment string that was removed
by the _quote_comment_stmt() method.
=cut
sub _restore_comment_stmt {
my ( $self, $str ) = @_;
if ( exists $self->{comment_str} ) {
$$str =~ s/PGF_CMTSTR(\d+)/$self->{comment_str}{$1}/igs;
}
}
=head2 _remove_comments
Internal function used to remove comments in SQL code
to simplify the work of the wrap_lines. Comments must be
restored with the _restore_comments() method.
=cut
sub _remove_comments {
my $self = shift;
my $idx = 0;
while ( $self->{'content'} =~ s/(\/\*(.*?)\*\/)/PGF_COMMENT${idx}A/s ) {
$self->{'comments'}{"PGF_COMMENT${idx}A"} = $1;
$idx++;
}
my @lines = split( /\n/, $self->{'content'} );
for ( my $j = 0 ; $j <= $#lines ; $j++ ) {
$lines[$j] //= '';
# Extract multiline comments as a single placeholder
my $old_j = $j;
my $cmt = '';
while ( $j <= $#lines && $lines[$j] =~ /^(\s*\-\-.*)$/ ) {
$cmt .= "$1\n";
$j++;
}
if ( $j > $old_j ) {
chomp($cmt);
$lines[$old_j] =~ s/^(\s*\-\-.*)$/PGF_COMMENT${idx}A/;
$self->{'comments'}{"PGF_COMMENT${idx}A"} = $cmt;
$idx++;
$j--;
while ( $j > $old_j ) {
delete $lines[$j];
$j--;
}
}
if ( $lines[$j] =~ s/(\s*\-\-.*)$/PGF_COMMENT${idx}A/ ) {
$self->{'comments'}{"PGF_COMMENT${idx}A"} = $1;
$idx++;
}
# Mysql supports differents kinds of comment's starter
if ( ( $lines[$j] =~ s/(\s*COMMENT\s+'.*)$/PGF_COMMENT${idx}A/ )
|| ( $lines[$j] =~ s/(\s*\# .*)$/PGF_COMMENT${idx}A/ ) )
{
$self->{'comments'}{"PGF_COMMENT${idx}A"} = $1;
# Normalize start of comment
$self->{'comments'}{"PGF_COMMENT${idx}A"} =~
s/^(\s*)COMMENT/$1\-\- /;
$self->{'comments'}{"PGF_COMMENT${idx}A"} =~ s/^(\s*)\#/$1\-\- /;
$idx++;
}
}
$self->{'content'} = join( "\n", @lines );
# Remove extra newline after comment
while ( $self->{'content'} =~ s/(PGF_COMMENT\d+A[\n])[\n]+/$1/s ) { }
# Replace subsequent comment by a single one
while ( $self->{'content'} =~
s/(PGF_COMMENT\d+A\s*PGF_COMMENT\d+A)/PGF_COMMENT${idx}A/s )
{
$self->{'comments'}{"PGF_COMMENT${idx}A"} = $1;
$idx++;
}
}
=head2 _restore_comments
Internal function used to restore comments in SQL code
that was removed by the _remove_comments() method.
=cut
sub _restore_comments {
my ( $self, $wrap_comment ) = @_;
if ( $self->{'wrap_limit'} && $wrap_comment ) {
foreach my $k ( keys %{ $self->{'comments'} } ) {
if ( $self->{'comments'}{$k} =~ /^(\s*)--[\r\n]/s ) {
next;
}
elsif ( $self->{'comments'}{$k} =~ /^(\s*)--/ ) {
my $indent = $1 || '';
if (
length( $self->{'comments'}{$k} ) > $self->{'wrap_limit'} +
( $self->{'wrap_limit'} * 10 / 100 ) )
{
my @data = split( /\n/, $self->{'comments'}{$k} );
map { s/^\s*--//; } @data;
$self->{'comments'}{$k} = join( "\n", @data );
$Text::Wrap::columns = $self->{'wrap_limit'};
my $t = wrap( '', ' ', $self->{'comments'}{$k} );
@data = split( /\n/, $t );
map { s/^/$indent--/; } @data;
$self->{'comments'}{$k} = join( "\n", @data );
}
else {
$self->{'comments'}{$k} =~ s/^\s*--//s;
$self->{'comments'}{$k} =
$indent . "--$self->{'comments'}{$k}";
}
# remove extra spaces after comment characters
$self->{'comments'}{$k} =~ s/--[ ]+/-- /gs;
}
}
}
while (
$self->{'content'} =~ s/(PGF_COMMENT\d+A)/$self->{'comments'}{$1}/s )
{
delete $self->{'comments'}{$1};
}
}
=head2 wrap_lines
Internal function used to wrap line at a certain length.
=cut
sub wrap_lines {
my ( $self, $wrap_comment ) = @_;
return if ( !$self->{'wrap_limit'} || !$self->{'content'} );
$self->_remove_comments();
my @lines = split( /\n/, $self->{'content'} );
$self->{'content'} = '';
foreach my $l (@lines) {
# Remove and store the indentation of the line
my $indent = '';
if ( $l =~ s/^(\s+)// ) {
$indent = $1;
}
if (
length($l) >
$self->{'wrap_limit'} + ( $self->{'wrap_limit'} * 10 / 100 ) )
{
$Text::Wrap::columns = $self->{'wrap_limit'};
my $t = wrap( $indent, " " x $self->{'spaces'} . $indent, $l );
$self->{'content'} .= "$t\n";
}
else {
$self->{'content'} .= $indent . "$l\n";
}
}
$self->_restore_comments( $wrap_comment || $self->{'wrap_comment'} )
if ( $self->{'content'} );
return;
}
sub _dump_var {
my $self = shift;
foreach my $v ( sort keys %{$self} ) {
next if ( $v !~ /^_/ );
if ( $self->{$v} =~ /ARRAY/ ) {
print STDERR "$v => (", join( ',', @{ $self->{$v} } ), ")\n";
}
else {
print STDERR "$v => $self->{$v}\n";
}
}
}
=head1 AUTHOR
pgFormatter is an original work from Gilles Darold
=head1 BUGS
Please report any bugs or feature requests to: https://github.com/darold/pgFormatter/issues
=head1 COPYRIGHT
Copyright 2012-2026 Gilles Darold. All rights reserved.
=head1 LICENSE
pgFormatter is free software distributed under the PostgreSQL Licence.
A modified version of the SQL::Beautify Perl Module is embedded in pgFormatter
with copyright (C) 2009 by Jonas Kramer and is published under the terms of
the Artistic License 2.0.
=cut
1;
}
__DATA__
WRFILE: jquery.jqplot.min.css
.jqplot-target{position:relative;color:#666;font-family:"Trebuchet MS",Arial,Helvetica,sans-serif;font-size:1em}.jqplot-axis{font-size:.75em}.jqplot-xaxis{margin-top:10px}.jqplot-x2axis{margin-bottom:10px}.jqplot-yaxis{margin-right:10px}.jqplot-y2axis,.jqplot-y3axis,.jqplot-y4axis,.jqplot-y5axis,.jqplot-y6axis,.jqplot-y7axis,.jqplot-y8axis,.jqplot-y9axis,.jqplot-yMidAxis{margin-left:10px;margin-right:10px}.jqplot-axis-tick,.jqplot-xaxis-tick,.jqplot-yaxis-tick,.jqplot-x2axis-tick,.jqplot-y2axis-tick,.jqplot-y3axis-tick,.jqplot-y4axis-tick,.jqplot-y5axis-tick,.jqplot-y6axis-tick,.jqplot-y7axis-tick,.jqplot-y8axis-tick,.jqplot-y9axis-tick,.jqplot-yMidAxis-tick{position:absolute;white-space:pre}.jqplot-xaxis-tick{top:0;left:15px;vertical-align:top}.jqplot-x2axis-tick{bottom:0;left:15px;vertical-align:bottom}.jqplot-yaxis-tick{right:0;top:15px;text-align:right}.jqplot-yaxis-tick.jqplot-breakTick{right:-20px;margin-right:0;padding:1px 5px 1px 5px;z-index:2;font-size:1.5em}.jqplot-y2axis-tick,.jqplot-y3axis-tick,.jqplot-y4axis-tick,.jqplot-y5axis-tick,.jqplot-y6axis-tick,.jqplot-y7axis-tick,.jqplot-y8axis-tick,.jqplot-y9axis-tick{left:0;top:15px;text-align:left}.jqplot-yMidAxis-tick{text-align:center;white-space:nowrap}.jqplot-xaxis-label{margin-top:10px;font-size:11pt;position:absolute}.jqplot-x2axis-label{margin-bottom:10px;font-size:11pt;position:absolute}.jqplot-yaxis-label{margin-right:10px;font-size:11pt;position:absolute}.jqplot-yMidAxis-label{font-size:11pt;position:absolute}.jqplot-y2axis-label,.jqplot-y3axis-label,.jqplot-y4axis-label,.jqplot-y5axis-label,.jqplot-y6axis-label,.jqplot-y7axis-label,.jqplot-y8axis-label,.jqplot-y9axis-label{font-size:11pt;margin-left:10px;position:absolute}.jqplot-meterGauge-tick{font-size:.75em;color:#999}.jqplot-meterGauge-label{font-size:1em;color:#999}table.jqplot-table-legend{margin-top:12px;margin-bottom:12px;margin-left:12px;margin-right:12px}table.jqplot-table-legend,table.jqplot-cursor-legend{background-color:rgba(255,255,255,0.6);border:1px solid #ccc;position:absolute;font-size:.75em}td.jqplot-table-legend{vertical-align:middle}td.jqplot-seriesToggle:hover,td.jqplot-seriesToggle:active{cursor:pointer}.jqplot-table-legend .jqplot-series-hidden{text-decoration:line-through}div.jqplot-table-legend-swatch-outline{border:1px solid #ccc;padding:1px}div.jqplot-table-legend-swatch{width:0;height:0;border-top-width:5px;border-bottom-width:5px;border-left-width:6px;border-right-width:6px;border-top-style:solid;border-bottom-style:solid;border-left-style:solid;border-right-style:solid}.jqplot-title{top:0;left:0;padding-bottom:.5em;font-size:1.2em}table.jqplot-cursor-tooltip{border:1px solid #ccc;font-size:.75em}.jqplot-cursor-tooltip{border:1px solid #ccc;font-size:.75em;white-space:nowrap;background:rgba(208,208,208,0.5);padding:1px}.jqplot-highlighter-tooltip,.jqplot-canvasOverlay-tooltip{border:1px solid #ccc;font-size:.75em;white-space:nowrap;background:rgba(208,208,208,0.5);padding:1px}.jqplot-point-label{font-size:.75em;z-index:2}td.jqplot-cursor-legend-swatch{vertical-align:middle;text-align:center}div.jqplot-cursor-legend-swatch{width:1.2em;height:.7em}.jqplot-error{text-align:center}.jqplot-error-message{position:relative;top:46%;display:inline-block}div.jqplot-bubble-label{font-size:.8em;padding-left:2px;padding-right:2px;color:rgb(20%,20%,20%)}div.jqplot-bubble-label.jqplot-bubble-label-highlight{background:rgba(90%,90%,90%,0.7)}div.jqplot-noData-container{text-align:center;background-color:rgba(96%,96%,96%,0.3)}
WRFILE: jquery.min.js
/*!
* jQuery JavaScript Library v1.9.1
* http://jquery.com/
*
* Includes Sizzle.js
* http://sizzlejs.com/
*
* Copyright 2005, 2012 jQuery Foundation, Inc. and other contributors
* Released under the MIT license
* http://jquery.org/license
*
* Date: 2013-2-4
*/
(function(a2,aG){var ai,w,aC=typeof aG,l=a2.document,aL=a2.location,bi=a2.jQuery,H=a2.$,aa={},a6=[],s="1.9.1",aI=a6.concat,ao=a6.push,a4=a6.slice,aM=a6.indexOf,z=aa.toString,V=aa.hasOwnProperty,aQ=s.trim,bJ=function(e,b3){return new bJ.fn.init(e,b3,w)},bA=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,ac=/\S+/g,C=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,br=/^(?:(<[\w\W]+>)[^>]*|#([\w-]*))$/,a=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,bh=/^[\],:{}\s]*$/,bk=/(?:^|:|,)(?:\s*\[)+/g,bG=/\\(?:["\\\/bfnrt]|u[\da-fA-F]{4})/g,aZ=/"[^"\\\r\n]*"|true|false|null|-?(?:\d+\.|)\d+(?:[eE][+-]?\d+|)/g,bS=/^-ms-/,aV=/-([\da-z])/gi,M=function(e,b3){return b3.toUpperCase()},bW=function(e){if(l.addEventListener||e.type==="load"||l.readyState==="complete"){bl();bJ.ready()}},bl=function(){if(l.addEventListener){l.removeEventListener("DOMContentLoaded",bW,false);a2.removeEventListener("load",bW,false)}else{l.detachEvent("onreadystatechange",bW);a2.detachEvent("onload",bW)}};bJ.fn=bJ.prototype={jquery:s,constructor:bJ,init:function(e,b5,b4){var b3,b6;if(!e){return this}if(typeof e==="string"){if(e.charAt(0)==="<"&&e.charAt(e.length-1)===">"&&e.length>=3){b3=[null,e,null]}else{b3=br.exec(e)}if(b3&&(b3[1]||!b5)){if(b3[1]){b5=b5 instanceof bJ?b5[0]:b5;bJ.merge(this,bJ.parseHTML(b3[1],b5&&b5.nodeType?b5.ownerDocument||b5:l,true));if(a.test(b3[1])&&bJ.isPlainObject(b5)){for(b3 in b5){if(bJ.isFunction(this[b3])){this[b3](b5[b3])}else{this.attr(b3,b5[b3])}}}return this}else{b6=l.getElementById(b3[2]);if(b6&&b6.parentNode){if(b6.id!==b3[2]){return b4.find(e)}this.length=1;this[0]=b6}this.context=l;this.selector=e;return this}}else{if(!b5||b5.jquery){return(b5||b4).find(e)}else{return this.constructor(b5).find(e)}}}else{if(e.nodeType){this.context=this[0]=e;this.length=1;return this}else{if(bJ.isFunction(e)){return b4.ready(e)}}}if(e.selector!==aG){this.selector=e.selector;this.context=e.context}return bJ.makeArray(e,this)},selector:"",length:0,size:function(){return this.length},toArray:function(){return a4.call(this)},get:function(e){return e==null?this.toArray():(e<0?this[this.length+e]:this[e])},pushStack:function(e){var b3=bJ.merge(this.constructor(),e);b3.prevObject=this;b3.context=this.context;return b3},each:function(b3,e){return bJ.each(this,b3,e)},ready:function(e){bJ.ready.promise().done(e);return this},slice:function(){return this.pushStack(a4.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(b4){var e=this.length,b3=+b4+(b4<0?e:0);return this.pushStack(b3>=0&&b30){return}ai.resolveWith(l,[bJ]);if(bJ.fn.trigger){bJ(l).trigger("ready").off("ready")}},isFunction:function(e){return bJ.type(e)==="function"},isArray:Array.isArray||function(e){return bJ.type(e)==="array"},isWindow:function(e){return e!=null&&e==e.window},isNumeric:function(e){return !isNaN(parseFloat(e))&&isFinite(e)},type:function(e){if(e==null){return String(e)}return typeof e==="object"||typeof e==="function"?aa[z.call(e)]||"object":typeof e},isPlainObject:function(b5){if(!b5||bJ.type(b5)!=="object"||b5.nodeType||bJ.isWindow(b5)){return false}try{if(b5.constructor&&!V.call(b5,"constructor")&&!V.call(b5.constructor.prototype,"isPrototypeOf")){return false}}catch(b4){return false}var b3;for(b3 in b5){}return b3===aG||V.call(b5,b3)},isEmptyObject:function(b3){var e;for(e in b3){return false}return true},error:function(e){throw new Error(e)},parseHTML:function(b6,b4,b5){if(!b6||typeof b6!=="string"){return null}if(typeof b4==="boolean"){b5=b4;b4=false}b4=b4||l;var b3=a.exec(b6),e=!b5&&[];if(b3){return[b4.createElement(b3[1])]}b3=bJ.buildFragment([b6],b4,e);if(e){bJ(e).remove()}return bJ.merge([],b3.childNodes)},parseJSON:function(e){if(a2.JSON&&a2.JSON.parse){return a2.JSON.parse(e)}if(e===null){return e}if(typeof e==="string"){e=bJ.trim(e);if(e){if(bh.test(e.replace(bG,"@").replace(aZ,"]").replace(bk,""))){return(new Function("return "+e))()}}}bJ.error("Invalid JSON: "+e)},parseXML:function(b5){var b3,b4;if(!b5||typeof b5!=="string"){return null}try{if(a2.DOMParser){b4=new DOMParser();b3=b4.parseFromString(b5,"text/xml")}else{b3=new ActiveXObject("Microsoft.XMLDOM");b3.async="false";b3.loadXML(b5)}}catch(b6){b3=aG}if(!b3||!b3.documentElement||b3.getElementsByTagName("parsererror").length){bJ.error("Invalid XML: "+b5)}return b3},noop:function(){},globalEval:function(e){if(e&&bJ.trim(e)){(a2.execScript||function(b3){a2["eval"].call(a2,b3)})(e)}},camelCase:function(e){return e.replace(bS,"ms-").replace(aV,M)},nodeName:function(b3,e){return b3.nodeName&&b3.nodeName.toLowerCase()===e.toLowerCase()},each:function(b7,b8,b3){var b6,b4=0,b5=b7.length,e=ab(b7);if(b3){if(e){for(;b40&&(b3-1) in b4)}w=bJ(l);var bY={};function ae(b3){var e=bY[b3]={};bJ.each(b3.match(ac)||[],function(b5,b4){e[b4]=true});return e}bJ.Callbacks=function(cc){cc=typeof cc==="string"?(bY[cc]||ae(cc)):bJ.extend({},cc);var b6,b5,e,b7,b8,b4,b9=[],ca=!cc.once&&[],b3=function(cd){b5=cc.memory&&cd;e=true;b8=b4||0;b4=0;b7=b9.length;b6=true;for(;b9&&b8-1){b9.splice(ce,1);if(b6){if(ce<=b7){b7--}if(ce<=b8){b8--}}}})}return this},has:function(cd){return cd?bJ.inArray(cd,b9)>-1:!!(b9&&b9.length)},empty:function(){b9=[];return this},disable:function(){b9=ca=b5=aG;return this},disabled:function(){return !b9},lock:function(){ca=aG;if(!b5){cb.disable()}return this},locked:function(){return !ca},fireWith:function(ce,cd){cd=cd||[];cd=[ce,cd.slice?cd.slice():cd];if(b9&&(!e||ca)){if(b6){ca.push(cd)}else{b3(cd)}}return this},fire:function(){cb.fireWith(this,arguments);return this},fired:function(){return !!e}};return cb};bJ.extend({Deferred:function(b4){var b3=[["resolve","done",bJ.Callbacks("once memory"),"resolved"],["reject","fail",bJ.Callbacks("once memory"),"rejected"],["notify","progress",bJ.Callbacks("memory")]],b5="pending",b6={state:function(){return b5},always:function(){e.done(arguments).fail(arguments);return this},then:function(){var b7=arguments;return bJ.Deferred(function(b8){bJ.each(b3,function(ca,b9){var cc=b9[0],cb=bJ.isFunction(b7[ca])&&b7[ca];e[b9[1]](function(){var cd=cb&&cb.apply(this,arguments);if(cd&&bJ.isFunction(cd.promise)){cd.promise().done(b8.resolve).fail(b8.reject).progress(b8.notify)}else{b8[cc+"With"](this===b6?b8.promise():this,cb?[cd]:arguments)}})});b7=null}).promise()},promise:function(b7){return b7!=null?bJ.extend(b7,b6):b6}},e={};b6.pipe=b6.then;bJ.each(b3,function(b8,b7){var ca=b7[2],b9=b7[3];b6[b7[1]]=ca.add;if(b9){ca.add(function(){b5=b9},b3[b8^1][2].disable,b3[2][2].lock)}e[b7[0]]=function(){e[b7[0]+"With"](this===e?b6:this,arguments);return this};e[b7[0]+"With"]=ca.fireWith});b6.promise(e);if(b4){b4.call(e,e)}return e},when:function(b6){var b4=0,b8=a4.call(arguments),e=b8.length,b3=e!==1||(b6&&bJ.isFunction(b6.promise))?e:0,cb=b3===1?b6:bJ.Deferred(),b5=function(cd,ce,cc){return function(cf){ce[cd]=this;cc[cd]=arguments.length>1?a4.call(arguments):cf;if(cc===ca){cb.notifyWith(ce,cc)}else{if(!(--b3)){cb.resolveWith(ce,cc)}}}},ca,b7,b9;if(e>1){ca=new Array(e);b7=new Array(e);b9=new Array(e);for(;b4
a";cd=b3.getElementsByTagName("*");cb=b3.getElementsByTagName("a")[0];if(!cd||!cb||!cd.length){return{}}cc=l.createElement("select");b5=cc.appendChild(l.createElement("option"));ca=b3.getElementsByTagName("input")[0];cb.style.cssText="top:1px;float:left;opacity:.5";ce={getSetAttribute:b3.className!=="t",leadingWhitespace:b3.firstChild.nodeType===3,tbody:!b3.getElementsByTagName("tbody").length,htmlSerialize:!!b3.getElementsByTagName("link").length,style:/top/.test(cb.getAttribute("style")),hrefNormalized:cb.getAttribute("href")==="/a",opacity:/^0.5/.test(cb.style.opacity),cssFloat:!!cb.style.cssFloat,checkOn:!!ca.value,optSelected:b5.selected,enctype:!!l.createElement("form").enctype,html5Clone:l.createElement("nav").cloneNode(true).outerHTML!=="<:nav>",boxModel:l.compatMode==="CSS1Compat",deleteExpando:true,noCloneEvent:true,inlineBlockNeedsLayout:false,shrinkWrapBlocks:false,reliableMarginRight:true,boxSizingReliable:true,pixelPosition:false};ca.checked=true;ce.noCloneChecked=ca.cloneNode(true).checked;cc.disabled=true;ce.optDisabled=!b5.disabled;try{delete b3.test}catch(b8){ce.deleteExpando=false}ca=l.createElement("input");ca.setAttribute("value","");ce.input=ca.getAttribute("value")==="";ca.value="t";ca.setAttribute("type","radio");ce.radioValue=ca.value==="t";ca.setAttribute("checked","t");ca.setAttribute("name","t");b9=l.createDocumentFragment();b9.appendChild(ca);ce.appendChecked=ca.checked;ce.checkClone=b9.cloneNode(true).cloneNode(true).lastChild.checked;if(b3.attachEvent){b3.attachEvent("onclick",function(){ce.noCloneEvent=false});b3.cloneNode(true).click()}for(b6 in {submit:true,change:true,focusin:true}){b3.setAttribute(b7="on"+b6,"t");ce[b6+"Bubbles"]=b7 in a2||b3.attributes[b7].expando===false}b3.style.backgroundClip="content-box";b3.cloneNode(true).style.backgroundClip="";ce.clearCloneStyle=b3.style.backgroundClip==="content-box";bJ(function(){var cf,ci,ch,cg="padding:0;margin:0;border:0;display:block;box-sizing:content-box;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;",e=l.getElementsByTagName("body")[0];if(!e){return}cf=l.createElement("div");cf.style.cssText="border:0;width:0;height:0;position:absolute;top:0;left:-9999px;margin-top:1px";e.appendChild(cf).appendChild(b3);b3.innerHTML="