Bug #21512106 FORMAT_PATH() DOES NOT CONSIDER DIRECTORY BOUNDARIES

Properly check directory boundaries on all variables now. If the variable does not include a path separator at the end of it, add one for comparison.

NOTE: This stops the case of converting Windows paths to /, and now correctly shows \ for Windows hosts.

Also added replacement for the basedir variable, and added a proper unit test that validates all variables are parsed correctly (though this requires disabling the test on Windows, as the path separator is now correctly shown as \ on that host too now).

Author: MarkLeith

functions/format_path.sql

@@ -1,4 +1,4 @@
--- Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
+-- Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved.
 --
 -- This program is free software; you can redistribute it and/or modify
 -- it under the terms of the GNU General Public License as published by
@@ -18,7 +18,7 @@ DROP FUNCTION IF EXISTS format_path;
 DELIMITER $$
 
 CREATE DEFINER='root'@'localhost' FUNCTION format_path (
-        path VARCHAR(512)
+        in_path VARCHAR(512)
     )
     RETURNS VARCHAR(512) CHARSET UTF8
     COMMENT '
@@ -68,30 +68,41 @@ BEGIN
   DECLARE v_path VARCHAR(512);
   DECLARE v_undo_dir VARCHAR(1024);
 
+  DECLARE path_separator CHAR(1) DEFAULT '/';
+
+  IF @@global.version_compile_os LIKE 'win%' THEN
+    SET path_separator = '\\';
+  END IF;
+
   -- OSX hides /private/ in variables, but Performance Schema does not
-  IF path LIKE '/private/%' 
-    THEN SET v_path = REPLACE(path, '/private', '');
-    ELSE SET v_path = path;
+  IF in_path LIKE '/private/%' THEN
+    SET v_path = REPLACE(in_path, '/private', '');
+  ELSE
+    SET v_path = in_path;
   END IF;
 
   -- @@global.innodb_undo_directory is only set when separate undo logs are used
-  SET v_undo_dir = IFNULL((SELECT VARIABLE_NAME FROM information_schema.GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'innodb_undo_directory'), '');
-
-  IF v_path IS NULL THEN RETURN NULL;
-  ELSEIF v_path LIKE CONCAT(@@global.datadir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.datadir, '@@datadir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.tmpdir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.tmpdir, '@@tmpdir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.slave_load_tmpdir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.slave_load_tmpdir, '@@slave_load_tmpdir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.innodb_data_home_dir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.innodb_data_home_dir, '@@innodb_data_home_dir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.innodb_log_group_home_dir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.innodb_log_group_home_dir, '@@innodb_log_group_home_dir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(v_undo_dir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, v_undo_dir, '@@innodb_undo_directory/'), '\\\\', ''), '\\', '/');
-  ELSE RETURN v_path;
+  SET v_undo_dir = IFNULL((SELECT VARIABLE_VALUE FROM information_schema.GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'innodb_undo_directory'), '');
+
+  IF v_path IS NULL THEN
+    RETURN NULL;
+  ELSEIF v_path LIKE CONCAT(@@global.datadir, IF(SUBSTRING(@@global.datadir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.datadir, CONCAT('@@datadir', IF(SUBSTRING(@@global.datadir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.tmpdir, IF(SUBSTRING(@@global.tmpdir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.tmpdir, CONCAT('@@tmpdir', IF(SUBSTRING(@@global.tmpdir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.slave_load_tmpdir, IF(SUBSTRING(@@global.slave_load_tmpdir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.slave_load_tmpdir, CONCAT('@@slave_load_tmpdir', IF(SUBSTRING(@@global.slave_load_tmpdir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.innodb_data_home_dir, IF(SUBSTRING(@@global.innodb_data_home_dir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.innodb_data_home_dir, CONCAT('@@innodb_data_home_dir', IF(SUBSTRING(@@global.innodb_data_home_dir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.innodb_log_group_home_dir, IF(SUBSTRING(@@global.innodb_log_group_home_dir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.innodb_log_group_home_dir, CONCAT('@@innodb_log_group_home_dir', IF(SUBSTRING(@@global.innodb_log_group_home_dir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(v_undo_dir, IF(SUBSTRING(v_undo_dir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, v_undo_dir, CONCAT('@@innodb_undo_directory', IF(SUBSTRING(v_undo_dir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.basedir, IF(SUBSTRING(@@global.basedir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.basedir, CONCAT('@@basedir', IF(SUBSTRING(@@global.basedir, -1) = path_separator, path_separator, '')));
   END IF;
+
+  RETURN v_path;
 END$$
 
 DELIMITER ;

functions/format_path_57.sql

@@ -1,4 +1,4 @@
--- Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
+-- Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved.
 --
 -- This program is free software; you can redistribute it and/or modify
 -- it under the terms of the GNU General Public License as published by
@@ -18,7 +18,7 @@ DROP FUNCTION IF EXISTS format_path;
 DELIMITER $$
 
 CREATE DEFINER='root'@'localhost' FUNCTION format_path (
-        path VARCHAR(512)
+        in_path VARCHAR(512)
     )
     RETURNS VARCHAR(512) CHARSET UTF8
     COMMENT '
@@ -68,30 +68,41 @@ BEGIN
   DECLARE v_path VARCHAR(512);
   DECLARE v_undo_dir VARCHAR(1024);
 
+  DECLARE path_separator CHAR(1) DEFAULT '/';
+
+  IF @@global.version_compile_os LIKE 'win%' THEN
+    SET path_separator = '\\';
+  END IF;
+
   -- OSX hides /private/ in variables, but Performance Schema does not
-  IF path LIKE '/private/%' 
-    THEN SET v_path = REPLACE(path, '/private', '');
-    ELSE SET v_path = path;
+  IF in_path LIKE '/private/%' THEN
+    SET v_path = REPLACE(in_path, '/private', '');
+  ELSE
+    SET v_path = in_path;
   END IF;
 
   -- @@global.innodb_undo_directory is only set when separate undo logs are used
-  SET v_undo_dir = IFNULL((SELECT VARIABLE_NAME FROM performance_schema.global_variables WHERE VARIABLE_NAME = 'innodb_undo_directory'), '');
-
-  IF v_path IS NULL THEN RETURN NULL;
-  ELSEIF v_path LIKE CONCAT(@@global.datadir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.datadir, '@@datadir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.tmpdir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.tmpdir, '@@tmpdir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.slave_load_tmpdir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.slave_load_tmpdir, '@@slave_load_tmpdir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.innodb_data_home_dir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.innodb_data_home_dir, '@@innodb_data_home_dir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(@@global.innodb_log_group_home_dir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, @@global.innodb_log_group_home_dir, '@@innodb_log_group_home_dir/'), '\\\\', ''), '\\', '/');
-  ELSEIF v_path LIKE CONCAT(v_undo_dir, '%') ESCAPE '|' THEN
-    RETURN REPLACE(REPLACE(REPLACE(v_path, v_undo_dir, '@@innodb_undo_directory/'), '\\\\', ''), '\\', '/');
-  ELSE RETURN v_path;
+  SET v_undo_dir = IFNULL((SELECT VARIABLE_VALUE FROM performance_schema.global_variables WHERE VARIABLE_NAME = 'innodb_undo_directory'), '');
+
+  IF v_path IS NULL THEN
+    RETURN NULL;
+  ELSEIF v_path LIKE CONCAT(@@global.datadir, IF(SUBSTRING(@@global.datadir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.datadir, CONCAT('@@datadir', IF(SUBSTRING(@@global.datadir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.tmpdir, IF(SUBSTRING(@@global.tmpdir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.tmpdir, CONCAT('@@tmpdir', IF(SUBSTRING(@@global.tmpdir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.slave_load_tmpdir, IF(SUBSTRING(@@global.slave_load_tmpdir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.slave_load_tmpdir, CONCAT('@@slave_load_tmpdir', IF(SUBSTRING(@@global.slave_load_tmpdir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.innodb_data_home_dir, IF(SUBSTRING(@@global.innodb_data_home_dir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.innodb_data_home_dir, CONCAT('@@innodb_data_home_dir', IF(SUBSTRING(@@global.innodb_data_home_dir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.innodb_log_group_home_dir, IF(SUBSTRING(@@global.innodb_log_group_home_dir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.innodb_log_group_home_dir, CONCAT('@@innodb_log_group_home_dir', IF(SUBSTRING(@@global.innodb_log_group_home_dir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(v_undo_dir, IF(SUBSTRING(v_undo_dir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, v_undo_dir, CONCAT('@@innodb_undo_directory', IF(SUBSTRING(v_undo_dir, -1) = path_separator, path_separator, '')));
+  ELSEIF v_path LIKE CONCAT(@@global.basedir, IF(SUBSTRING(@@global.basedir, -1) = path_separator, '%', CONCAT(path_separator, '%'))) ESCAPE '|' THEN
+    SET v_path = REPLACE(v_path, @@global.basedir, CONCAT('@@basedir', IF(SUBSTRING(@@global.basedir, -1) = path_separator, path_separator, '')));
   END IF;
+
+  RETURN v_path;
 END$$
 
 DELIMITER ;

mysql-test/suite/sysschema/r/fn_format_path.result

@@ -1,18 +1,30 @@
 SELECT sys.format_path(NULL);
 sys.format_path(NULL)
 NULL
+SET @mypath := CONCAT(@@global.basedir, '/logs/binlog.000001');
+SELECT sys.format_path(@mypath);
+sys.format_path(@mypath)
+@@basedir/logs/binlog.000001
 SET @mypath := CONCAT(@@global.datadir, 'foo/bar.foo');
 SELECT sys.format_path(@mypath);
 sys.format_path(@mypath)
 @@datadir/foo/bar.foo
-SET @mypath := CONCAT(@@global.tmpdir, 'foo/bar.foo');
+SET @mypath := CONCAT(@@global.tmpdir, '/foo/bar.foo');
 SELECT sys.format_path(@mypath);
 sys.format_path(@mypath)
 @@tmpdir/foo/bar.foo
-SET @mypath := CONCAT(@@global.innodb_log_group_home_dir, 'foo/bar.foo');
+SET @mypath := CONCAT(@@global.innodb_data_home_dir, '/foo/bar.ibd');
+SELECT sys.format_path(@mypath);
+sys.format_path(@mypath)
+@@innodb_data_home_dir/foo/bar.ibd
+SET @mypath := CONCAT(@@global.innodb_log_group_home_dir, '/ib_logfile0');
+SELECT sys.format_path(@mypath);
+sys.format_path(@mypath)
+@@innodb_log_group_home_dir/ib_logfile0
+SET @mypath := CONCAT(@@global.innodb_undo_directory, '/undo0');
 SELECT sys.format_path(@mypath);
 sys.format_path(@mypath)
-@@innodb_log_group_home_dir/foo/bar.foo
+@@innodb_undo_directory/undo0
 SELECT sys.format_path('/foo/bar/baz.foo');
 sys.format_path('/foo/bar/baz.foo')
 /foo/bar/baz.foo

mysql-test/suite/sysschema/t/fn_format_path-master.opt

@@ -0,0 +1 @@
+--innodb_data_home_dir=$MYSQLTEST_VARDIR/tmp/innodb --innodb_log_group_home_dir=$MYSQLTEST_VARDIR/tmp/innodb_logs --innodb_undo_directory=$MYSQLTEST_VARDIR/tmp/innodb_undo

mysql-test/suite/sysschema/t/fn_format_path-master.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+mkdir $MYSQLTEST_VARDIR/tmp/innodb
+cp $MYSQLTEST_VARDIR/install.db/ibdata1 $MYSQLTEST_VARDIR/tmp/innodb
+cp $MYSQLTEST_VARDIR/install.db/ib_buffer_pool $MYSQLTEST_VARDIR/tmp/innodb
+mkdir $MYSQLTEST_VARDIR/tmp/innodb_logs
+cp $MYSQLTEST_VARDIR/install.db/ib_logfile* $MYSQLTEST_VARDIR/tmp/innodb_logs
+mkdir $MYSQLTEST_VARDIR/tmp/innodb_undo

mysql-test/suite/sysschema/t/fn_format_path.test

@@ -1,26 +1,40 @@
 -- source include/not_embedded.inc
+# Windows paths are \ not /, so ignore here
+-- source include/not_windows.inc
 # Tests for sys schema
 # Verify the sys.format_path() function perfoms as expected
 #
-# Note, innodb_data_home_dir replacement is not tested,
-# as this is not set by default
-#
 
 # Passing NULL should return NULL
 SELECT sys.format_path(NULL);
 
+# Ensure basedir is recognized and stripped
+SET @mypath := CONCAT(@@global.basedir, '/logs/binlog.000001');
+
+SELECT sys.format_path(@mypath);
+
 # Ensure datadir is recognized and stripped
 SET @mypath := CONCAT(@@global.datadir, 'foo/bar.foo');
 
 SELECT sys.format_path(@mypath);
 
 # Ensure tmpdir is recognized and stripped
-SET @mypath := CONCAT(@@global.tmpdir, 'foo/bar.foo');
+SET @mypath := CONCAT(@@global.tmpdir, '/foo/bar.foo');
+
+SELECT sys.format_path(@mypath);
+
+# Ensure innodb_data_home_dir is recognized and stripped
+SET @mypath := CONCAT(@@global.innodb_data_home_dir, '/foo/bar.ibd');
 
 SELECT sys.format_path(@mypath);
 
 # Ensure innodb_log_group_home_dir is recognized and stripped
-SET @mypath := CONCAT(@@global.innodb_log_group_home_dir, 'foo/bar.foo');
+SET @mypath := CONCAT(@@global.innodb_log_group_home_dir, '/ib_logfile0');
+
+SELECT sys.format_path(@mypath);
+
+# Ensure innodb_undo_directory is recognized and stripped
+SET @mypath := CONCAT(@@global.innodb_undo_directory, '/undo0');
 
 SELECT sys.format_path(@mypath);