DBI Query Plugin

Overview

This plugin is intended to provide TWiki with ability to make complex database requests using DBI Perl module.

Syntax Rules

Syntax:

%DBI_QUERY{"db_identifier" ...}%
SELECT ...
.header
head
.body
%column%
%DBI_SUBQUERY{"name"}%
.footer
footer
%DBI_QUERY%

%DBI_DO{"db_identifier" ...}%
# Some Perl code.
%DBI_DO%

%DBI_DO{"db_identifier" topic="SomeTopic" script="some_script"}%

%DBI_CALL{"subquery"}%

%DBI_CODE{...}%
# Some Perl Code
%DBI_CODE%

DBI_QUERY

Each query consist of two parts: a query statement (SELECT) and output formatting filters. SQL statement starts just after the leading %DBI_QUERY{...}% declaration. The filters are defined by .header, .body, and .footer keywords each starting at the beginning of line. Their meaning shall be obvious from their name:

Read below on how this plugin works in order to get more detailed explanation of the meaning of each syntax element.

Parameters:

A small note on protected parameter. Say, one has an arbitrary data in a displayed column which could contain any kind of text strings. What happens if a TWiki variable is found in a string? It gets expanded by TWiki, for sure. Adding this columns to the protected list prevents the expansion. Precisely saying, the whole purpose of protection is displaying of data as is, without any modification.

DBI_DO

As a matter of fact, %DBI_DO{...}% is nothing but a Perl CGI script stored withing TWiki. There are three ways to store it:

1. In place, just between starting %DBI_DO{...}% and ending %DBI_DO%.
2. In a separate topic which would be then the script on its own.
3. Several scripts in a topic using %DBI_CODE{...}%.

Parameters:

DBI_CALL

%DBI_CALL{...}% directly calls a subquery.

Parameters:

Moreover, named parameters are transfered to a subquery as if they are columns of a database record. Consider the following example:

%DBI_CALL{"example" uid="12"}%

%DBI_QUERY{"db_identifier" subquery="example"}%
SELECT
    name
  FROM
    Users
  WHERE
    id = %uid%
.header
....
%DBI_QUERY%

Read more in Variable Expansion section.

DBI_CODE

%DBI_CODE{...}% is used for keeping several %DBI_DO% scripts within single topic. A script is kept between starting %DBI_CODE{...}% and ending %DBI_CODE%. Output is formatted as a table representing script's name and code.

Parameters:

Note: Special support is provided for SourceHighlightPlugin.

How it works

DBI_QUERY

This plugin has been written with the idea in mind that table is not the only way to represent database content. Therefore some more flexibility is required in order to format a query result. Yet, what could provide more control over the output than templates keeping it all as simple as possible?

With this view in mind we come to the following procedure:

1. Every query definition within topic is parsed and stored for further processing. This is done in two major steps:
   1. Query statement is exctracted from the definition.
   2. Every newline within .header, .body, and .footer gets changed with space except for the last ones. They're removed. Whereas newline is needed \n escape sequence must be used. Consequently, \\n is translated into \n.
2. All queries are processed except for those declared as subqueries:
   1. .header filter is expanded with variable expansion mechanizm and put into the output.
   2. The query statement is expanded using DBIQueryPlugin and TWiki variable expansion mechanisms in the order they are mentioned here.
   3. Database is queried and data is fetched row-by-row. Each row data get quoted and then used for setting DBIQueryPlugin variables. .body filter is expanded using these values.
   4. .footer filter is expanded with DBIQueryPlugin mechanism and put into the output.
   5. Afterwards we let TWiki to mangle with the output (expand variables, pass it through other plugins, whatsoever).

Variable Expansion

The first step of expansion is done by changing every %column% variable found in a text being expanded with corresponding value from the database. Variable names are in fact table column names as they're declared in the SQL statement and returned by DBI module. NAME_lc case conversion performed so that every name is in lowercase. For instance, the following SELECT:

SELECT
    Name,
    PersonalID,
    SomeOtherInfo
  FROM
    PersonData

would provide us with variables %name%, %personalid%, %someotherinfo%.

There are some special cases like SHOW CREATE PROCEDURE query where column names may contain spaces within them. These spaces are changed with undersocre sign making it possible to refer to them as to database columns. I.e. 'Create Procedure' may be referred as %create_procedure%.

The second step is subquery processing. %DBI_SUBQUERY{"subqueryname"}% statements are replaced with output from corresponding subqueries. All currently defined variables are passed to the subquery making it possible to use them for SQL statement, header and footer expansion.

Quoting of Values

Values fetched from database are quoted using CGI::escapeHTML() unless contrary behaviour dictated by unquoted parameter. Then every newline character is changed with TWiki variable %BR%.

Subqueries

Subqueries are processed in same manner as common queries. The only thing which makes them slightly different in behaviour is the fact that they can use column values (variables) from the parent queries. It is also possible to have a chain of subqueries: top_query -> subquery1 -> subquery2 -> ..., in which case all variables from all the calling queries are accessible.

For instance, in the following code:

%DBI_QUERY{...}%
SELECT
    col1, col2
  FROM
    someTable
  WHERE
    col3 = %parent_query_col1%
.body
...
%DBI_QUERY%

we choose only the rows which are somehow related to a row in a parent query. Of course, relatively similar approach would be to use nested SELECT in the parent query SQL statement. Yet, this would be faster. But there are old versions of MySQL where nested SELECT is not supported. And there are situations when some more output formatting is needed. Or one could form header and/or footer using data contained in database.

Warning: Column names may overlap with parent queries. In this case parent has influence over child's SQL statement, header and footer definitions; whereas .body uses subquery column names. Take care of this! Best of all avoid this situation by using SQL aliasing:

Parent:

SELECT col1 as parent_col1
....

Subquery:

SELECT col1 as subquery_col1
...

Note: Subqueries could also be called recursively. Although a single query could not be called more than 100 times in a row. This number is presently hardcoded but will become part of plugin settings in future.

DBI_DO

First of all it shall be stated that %DBI_DO% could implement all required functionality. In other words, one could say that %DBI_QUERY% becomes obsolete. This is obvious from the syntax description. But it also implies that %DBI_DO% is:

• a security risk (see Access Control);
• too complicated for most queries;

Besides, %DBI_QUERY% hides quite a number of boring implementation details from a user.

So, let's define %DBI_DO% as a last resort method when nothing else could do the job. The most typical use for it would be database editing.

Implementation

As it was stated in syntax section, %DBI_DO% can fetch a script from another topics which would either represent the whole script or contain %DBI_CODE% declarations. In both cases the script is visible on the topic's page. For instance, the following declaration:

%DBI_CODE{"test"}%
if ($varParams{test}) {
    $rc = "This is test.";
} else {
    $rc = "This is for real.";
}
%DBI_CODE%

would output table like this:

if ($varParams{test}) {
    $rc = "This is test.";
} else {
    $rc = "This is for real.";
}

It would look much better with SourceHighlightPlugin:

%DBI_CODE{"test"}%
%CODE{"perl"}%
if ($varParams{test}) {
    $rc = "This is test.";
} else {
    $rc = "This is for real.";
}
%ENDCODE%
%DBI_CODE%

if ($varParams{test}) {
     $rc = "This is test.";
} else {
     $rc = "This is for real.";
}

%DBI_DO% knows about existence of %CODE%/%ENDCODE% and attempts to strip these tags out just after the script has been fetched from a topic. After that Perl code becomes a part of an anonymous sub. Several variables are available to the code:

Since the sub is executed within plugin's module namespace all internal functions and variables are directly accessible. The most useful of them are described below.

There is one special variable $rc. A value assigned to it is the value returned by sub and put into the output then. In this way one could display a error message or notification or form any kind of TWiki/HTML code.

Useful functions

The following plugin functions could be useful while creating a script:

db_connect($db_identifier)

Useful when connection to another database needed. $db_identifier parameter is database ID as specified in the plugin configuration.

subQuery($subquery, $dbRecord)

Implements %DBI_SUBQUERY% and %DBI_CALL%. $subquery is the name of subquery to be called. $dbRecord has the same meaning as corresponding sub parameter.

expandColumns($text, $dbRecord)

Expands variables within $text as described in DBIQueryPlugin Expansion.

protectValue($text)

Returns $text value modified in a way that prevents it from TWiki processing.

wikiErrMsg(@msg)

Use it for presenting error messages in a uniform way.

Database connection configuration

This plugin relies on the TWiki:Plugins.DatabaseContrib to provide the connection to a DBI database. Please see the contrib for documentation of how to specify the database connection.

Below is an example of the configuration of two database connections, connection1 and test, to be inserted into the DatabaseContrib section of the configure script.

    connection1 => {
        usermap => {
            TWikiAdminGroup => {
                user => 'dbuser1',
                password => 'dbpassword1',
            },
            SpecialGroup => {
                user => 'specialdb',
                password => 'specialpass',
            },
        },
        user => 'guest',
        password => 'guestpass',
        driver => 'mysql',
        database => 'some_db',
        codepage => 'koi8r',
        host => 'your.server.name',
    },
    test => {
        usermap => {
            TWikiAdminGroup => {
                user => 'dbuser2',
                password => 'dbpassword2',
            },
            SomeUser => {
                user => 'someuser',
                password => 'somepassword',
            },
        },
        allow_do => {
            default => [qw(TWikiAdminGroup)],
            'Sandbox.SomeUserSandbox' => [qw(TWikiAdminGroup SpecialGroup)],
        },
        #user => 'nobody',
        #password => 'never',
        driver => 'mysql',
        database => 'test',
        # host => 'localhost',
    }

Access Control

This plugin relies on the TWiki:Plugins.DatabaseContrib for access control.

Additional access protection is implemented for %DBI_DO%, relying on the allow_do key of the configuration specification.

In the example above, for database test, members of the TWikiAdminGroup may perform queries on any topic; users in SpecialGroup may execute %DBI_DO% queries on Sandbox.SomeUserSandbox.

Drawback and problems

Working with a database isn't a simple task, in common. With this plugin I was trying to make it both as simple as possible and flexible same time. Balancing between these two extremes led to some compromises and side effects.

The biggest compromise was usage of Perl inlines for %DBI_DO%. The first approach was to make it working much like %DBI_QUERY%, using sections of declarations. But the more quiestions like:

• how to check data consistency?
• how to validate data?
• how to generate error messages?

and several others of the kind was arising, the more final structure was looking like a new language. So, why developing a new one if Perl is here? But then again, as it was mentioned before, this way is not secure-enough and an administrator must take serious considerations before allowing usage of %DBI_DO% to a user.

The other issue is about plugin execution order. As one can see from MessageBoard example, attached to this topic, usage of other plugins could significally improve control over DBIQueryPlugin output. However, it is not guaranteed that another plugin would not be called in first place causing unpredictable results like unwanted changes in a Perl script.

Considering this issue the decision was made that DBIQueryPlugin must act as a preprocessor. For those who understand, it does all the job in beforeCommonTagsHandler() routine. This approach has three major drawbacks:

• First of all, it doesn't really follow the guidelines.
• It breaks common logic of page analysis. Consider the following example:

         %CALC{"$SET(var,1)"}%
         %DBI_QUERY{"..."}%
         SELECT ...
           WHERE
             field = %CALC{"$GET(var)"}%
         %DBI_QUERY%
         

One will not get what would be expected because at the time %CALC{"$GET(var)"}% is executed %CALC{"$SET(var,1)"}% has not been called yet! The only way to have it be done properly is to put the latter just under %DBI_QUERY{...}% line.

• %INCLUDE{}% would not work because beforeCommonTagsHandler() is not called for included topics.

The last issue was the cause to implement classic plugin handling when it is requested during the inclusion procedure. Possible side effects of this hack are not studied yet and may create some headache.

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %DBIQUERYPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Make complex database queries using DBI Perl module

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Install TWiki:Plugins.DatabaseContrib
  • Download the ZIP file from the Plugins home (see below).
  • Unzip DBIQueryPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/DBIQueryPlugin.txt	Plugin topic
    lib/TWiki/Plugins/DBIQueryPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Test if the installation was successful

Plugin Info

Plugin Author:	TWiki:Main.VadimBelman
Copyright:	© 2005-2006 TWiki:Main.VadimBelman © 2009 TWiki:Main.ThomasWeigert © 2008-2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-03-13
Change History:
2011-03-13:	TWikibug:Item6662: Initial import into SVN; doc fixes; change TWIKIWEB to SYSTEMWEB -- TWiki:Main.DipuDeshmukh
2009-05-20:	Use TWiki:Plugins.DatabaseContrib to provide connection services to the database -- TWiki:Main.ThomasWeigert
2009-05-18:	Updated to work in TWiki 4.2.4. Corrected the Message Board example -- TWiki:Main.ThomasWeigert
2006-06-03:	1.2: Added 'dsn' and 'init' parameters of configuration file. Character set support for PostgreSQL. No default value for 'allow_do' parameter of configuration file. Support for column names with spaces.
2005-10-17:	1.1
2005-10-13:	Initial version
CPAN Dependencies:	CPAN:DBI, CPAN:Error
Other Dependencies:	TWiki:Plugins.DatabaseContrib
Perl Version:	5.8
TWiki:Plugins/Benchmark:	GoodStyle nn%, FormattedSearch nn%, DBIQueryPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/DBIQueryPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/DBIQueryPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/DBIQueryPluginAppraisal

Related Topics: DatabaseContrib, TWikiPreferences, TWikiPlugins