Item11871: Initial checkin of SqlGridPlugin

git-svn-id: http://svn.foswiki.org/trunk/SqlGridPlugin@14836 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

data/System/SqlGridPlugin.txt

@@ -0,0 +1,36 @@
+---+!! !SqlGridPlugin
+<!--
+One line description, required for extensions repository catalog.
+BuildContrib will fill in the SHORTDESCRIPTION with the value of
+$SHORTDESCRIPTION from the .pm module, or you can redefine it here if you
+prefer.
+   * Set SHORTDESCRIPTION = %$SHORTDESCRIPTION%
+-->
+%SHORTDESCRIPTION%
+
+%TOC%
+
+---++ Usage
+
+---++ Examples
+
+---++ Installation Instructions
+
+%$INSTALL_INSTRUCTIONS%
+
+---++ Info
+
+Many thanks to the following sponsors for supporting this work:
+   * Acknowledge any sponsors here
+
+|  Author(s): | |
+|  Copyright: | &copy; |
+|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
+|  Release: | %$RELEASE% |
+|  Version: | %$VERSION% |
+|  Change History: | <!-- versions below in reverse order -->&nbsp; |
+|  Dependencies: | %$DEPENDENCIES% |
+|  Home page: | http://foswiki.org/bin/view/Extensions/SqlGridPlugin |
+|  Support: | http://foswiki.org/bin/view/Support/SqlGridPlugin |
+
+<!-- Do _not_ attempt to edit this topic; it is auto-generated. -->

data/System/SqlGridPluginDialogs.txt

@@ -0,0 +1,14 @@
+---+++ Confirmation dialog
+Parameters:
+   * title - message to be displayed
+   * message - message to be displayed
+   * ok_action - action when OK button is clicked
+   * cxl_action - action when cancel button is clicked
+
+%STARTSECTION{"confirm_dialog"}%
+<div title="%URLPARAM{title}%" class="jqUIDialog { modal:true, resizable:true, draggable:true, height:400, width:600}">
+%URLPARAM{"message"}%
+  <a class="jqUIDialogButton {icon:'ui-icon-circle-check'}" onclick="alert('hi'); false"  >%MAKETEXT{"Ok"}%</a>
+  <a class="jqUIDialogButton jqUIDialogClose {icon:'ui-icon-cancel'}">%MAKETEXT{"Cancel"}%</a>
+</div>
+%ENDSECTION{"confirm_dialog"}%

lib/Foswiki/Plugins/SqlGridPlugin.pm

@@ -0,0 +1,321 @@
+# Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
+#
+# Copyright (C) 2012 Kip Lubliner, http://kiplubliner.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details, published at
+# http://www.gnu.org/copyleft/gpl.html
+#
+# As per the GPL, removal of this notice is prohibited.
+
+=pod
+
+---+ package Foswiki::Plugins::SqlGridPlugin
+
+
+=cut
+
+package Foswiki::Plugins::SqlGridPlugin;
+
+use strict;
+use warnings;
+
+use Foswiki::Func    ();    # The plugins API
+use Foswiki::Plugins ();    # For the API version
+use Foswiki::Plugins::JQueryPlugin::Plugins;
+use Foswiki::Plugins::SqlPlugin;
+
+use Foswiki::Plugins::SqlGridPlugin::SqlParser;
+
+our $VERSION = '$Rev: 13288 $';
+our $RELEASE = '0.0.1';
+our $SHORTDESCRIPTION = 'Javascript interface for updating an SQL database';
+our $NO_PREFS_IN_TOPIC = 1;
+
+use constant DEBUG => 1; # toggle me
+sub writeDebug($) {
+#	my $f = __FILE__;
+#	$f =~ s@^.*[/\\]([^/\\]+[/\\][^/\\]+)$@$1@; #Dir/File.pm
+
+	my ($package, $filename, $line, $subroutine, $hasargs,
+    $wantarray, $evaltext, $is_require, $hints, $bitmask, $hinthash)
+     = caller(1);
+
+	$subroutine =~ s@^.*::([^:]+::[^:]+)$@$1@;
+
+	Foswiki::Func::writeDebug($subroutine, $_[0]);
+}
+
+# SMELL make this a preference
+my $purgeSqlDependencies = 1;
+
+sub initPlugin {
+    my ( $topic, $web, $user, $installWeb ) = @_;
+
+    if ( $Foswiki::Plugins::VERSION < 2.0 ) {
+        Foswiki::Func::writeWarning( 'Version mismatch between ',
+            __PACKAGE__, ' and Plugins.pm' );
+        return 0;
+    }
+    Foswiki::Func::registerTagHandler( 'SQLGRID', \&SQLGRID );
+    Foswiki::Func::registerRESTHandler( 'simpleupdate', \&restSimpleupdate );
+    Foswiki::Func::registerRESTHandler( 'simpleinsert', \&restSimpleinsert );
+    return 1;
+}
+
+#use File::Spec;
+#use Storable;
+#
+#sub loadSql0 {
+#	my $sql = $_[0];
+#	my $workArea = Foswiki::Func::getWorkArea( 'SqlGridPlugin' );
+#	my $fileCache = File::Spec->catfile($workArea, 'queryCache.txt');
+#
+#	my $cache = {};
+#	if (-f $fileCache) {
+#		$cache = retrieve($fileCache);
+#	}
+#	if (exists $cache->{$sql}) {
+#		return $cache->{$sql};
+#	}
+#	$cache->{$sql} = Foswiki::Plugins::SqlGridPlugin::SqlParser::parse($sql);
+#	store $cache, $fileCache;
+#	return $cache->{$sql};
+#}
+
+sub loadSql {
+	my $sql = $_[0];
+	Foswiki::Plugins::SqlGridPlugin::SqlParser::parse($sql);
+}
+
+sub SQLGRID {
+    my($session, $params, $topic, $web, $topicObject) = @_;
+	writeDebug("attrs " . $params->stringify())
+		if DEBUG;
+
+	my $id;
+	if (exists $params->{id}) {
+		$id = $params->{id};
+	} else {
+		$id = $params->{id} = "SqlGridPlugin" . Foswiki::Plugins::JQueryPlugin::Plugins::getRandom();
+	}
+	my $jsFunc = "onSqlGridLoad$id";
+	if (exists $params->{gridComplete}) {
+		$params->{gridComplete} = "function() {  " . $jsFunc . "(); " . $params->{gridComplete} . " }";
+	} else {
+		$params->{gridComplete} = $jsFunc;
+	}
+
+	my $idcol = $params->{idcol_connectorparam} = $params->remove('idcol') || '';
+
+	$params->{fromwhere_params_connectorparam} = $params->remove('sqlparams') || '';
+
+	my $theSqlQuery = $params->{sql} || '';
+	my $h = loadSql($theSqlQuery);
+	while( my ($k,$v) = each %$h) {
+		$params->{$k} = $v;
+	}
+
+#   SMELL Think that this is dead code.
+	my $ondblClickRow = $params->remove('ondblClickRow');
+
+	my $table = $params->remove('table');
+	my $dbconn = $params->{'dbconn_connectorparam'};
+#	my $idcol = $params->{'_conn_idcol'};
+
+	my $editform = $params->{'editform'} || '';
+	my $addform = $params->{'addform'} || '';
+
+#   SMELL Think that this is dead code.
+	my $onSelectRowScript = '';
+#	if ($onSelectRow) {
+	if (0) {
+		$onSelectRowScript = <<EOQ;
+    jQuery('#$id').jqGrid('setGridParam', {
+	    onSelectRow: function() { alert('select row') }
+    });
+    //.trigger('reloadGrid');
+EOQ
+	}
+
+##	# TODO also check in %MAINWEB% first
+#	my $prefix = "%SCRIPTURL{view}%/%SYSTEMWEB%/SqlGridPluginDialogs?skin=text";
+
+#	my $addArgs;
+#	my $editArgs = "requireSelection: true, gridId: '$id', form: 'http://127.0.0.1:8080/fwdev/Sandbox/GothamsPlayerForms?skin=text&section=edit_dialog'";
+#	my $delArgs = "requireSelection: true, gridId: '$id', form: '${prefix};section=confirm_dialog;title=Delete;message=Not%20Implemented'";
+
+	my $editScript = '';
+	if ($editform) {
+		my %editArgs = ( requireSelection => "true", gridId => "'$id'" );
+		$editArgs{form} = "'$editform'";
+		$editArgs{formAction} = "'" . Foswiki::urlEncode(Foswiki::Func::getScriptUrl(
+	          'SqlGridPlugin', 'simpleupdate', 'rest',
+	          dbconn => $dbconn,
+	          table => $table,
+	          idcol => $idcol
+	          )) . "'";
+		my $editArgs = join ', ', map { "$_: $editArgs{$_}" } keys %editArgs;
+		$editScript = addGridButton($id, 'Edit', 'Edit current record', 'ui-icon-pencil', $editArgs);
+	}
+
+	my $addScript = '';
+	if ($addform) {
+		my %addArgs = ( gridId => "'$id'" );
+		$addArgs{form} = "'$addform'";
+		$addArgs{formAction} = "'" . Foswiki::urlEncode(Foswiki::Func::getScriptUrl(
+	          'SqlGridPlugin', 'simpleinsert', 'rest',
+	          dbconn => $dbconn,
+	          table => $table,
+	          idcol => $idcol
+	          )) . "'";
+		my $addArgs = join ', ', map { "$_: $addArgs{$_}" } keys %addArgs;
+		$addScript = addGridButton($id, 'Add', 'Add a new record', 'ui-icon-plusthick', $addArgs);
+	}
+
+	my $delScript = '';
+
+	my $script=<<EOQ
+%JQREQUIRE{"ui::dialog, ui::button"}%
+%ADDTOZONE{"script" id="SqlGridPlugin" requires="JQUERYPLUGIN::UI::DIALOG"
+text="<script type='text/javascript' src='%PUBURLPATH%/%SYSTEMWEB%/SqlGridPlugin/gridfuncs.js'></script>
+<script type='text/javascript'>
+  var sqlPluginObjs = {}; // SMELL - should be run once
+  sqlPluginObjs.$id = {};
+  sqlPluginObjs.$id.hasInitRun = 0;
+
+//  var hasRan_$jsFunc = 0;
+  function $jsFunc() {
+    if (sqlPluginObjs.$id.hasInitRun != 0)
+      return;
+    sqlPluginObjs.$id.hasInitRun = 1;
+    var pagerId = jQuery('#$id').jqGrid('getGridParam', 'pager');
+
+    $addScript
+    $editScript
+    $delScript
+
+$onSelectRowScript
+
+  }
+</script>"}%
+EOQ
+;
+    return "$script\n\%GRID{" . $params->stringify() . "}\%";
+}
+
+sub addGridButton {
+	my ($id, $label, $hover, $icon, $funcArgs) = @_;
+	return <<EOQ;
+    jQuery('#$id').jqGrid('navButtonAdd', pagerId, {
+      caption:'%MAKETEXT{"$label"}%',
+      title:'%MAKETEXT{"$hover"}%', 
+      buttonicon:'$icon',
+      onClickButton: function () {
+        sqlgrid_showForm({ $funcArgs });
+      }
+    });
+EOQ
+}
+
+=head Params for Delete, if I get around to implementing it
+    jQuery('#$id').jqGrid('navButtonAdd', pagerId, {
+      caption:'%MAKETEXT{"Delete"}%',
+      title:'%MAKETEXT{"Delete current record"}%', 
+      buttonicon:'ui-icon-scissors',
+      onClickButton: function () {
+        sqlgrid_showForm({ $delArgs });
+      }
+//      onClickButton: sqlgrid_delrecord
+    });
+=cut
+
+sub _getRestParams {
+	my $request = $_[0];
+
+	my $dbconn = $request->param('dbconn');
+	my $table = $request->param('table');
+	my $idcol = $request->param('idcol');
+
+	$dbconn =~ s/[^\w]//g;
+	$table =~ s/[^\w]//g;
+	$idcol =~ s/[^\w]//g;
+
+	my @keys = ();
+	my @args = ();
+	for my $p ($request->param()) {
+		my $col = $p;
+		if ($col =~ s/^col_// && $col ne $idcol) {
+			$col =~ s/[^\w]//g;
+			my $val = $request->param($p);
+			push @keys, $col;
+			push @args, $val;
+		}
+	}
+	my $idval = $request->param("col_$idcol");
+
+	return ($dbconn, $table, $idcol, $idval, \@keys, \@args);
+}
+
+sub restSimpleupdate {
+	my ($session, $subject, $verb, $response) = @_;
+	my $request = Foswiki::Func::getCgiQuery();
+	writeDebug($request->query_string())
+		if DEBUG;
+
+	my ($dbconn, $table, $idcol, $idval, $keys, $args) = _getRestParams($request);
+	my $setStmt = join ', ', map { "$_ = ?" } @$keys;
+
+	my $sql = "UPDATE $table SET $setStmt WHERE $idcol = ?";
+	push @$args, $idval;
+
+writeDebug($sql . join ',', @$args);
+
+	my $sth = Foswiki::Plugins::SqlPlugin::execute($dbconn, $sql, @$args);
+	$sth->finish;
+
+#	cleanPageCache($table);
+
+	return "1";
+}
+
+
+sub restSimpleinsert {
+	my ($session, $subject, $verb, $response) = @_;
+	my $request = Foswiki::Func::getCgiQuery();
+	writeDebug($request->query_string())
+		if DEBUG;
+
+	my ($dbconn, $table, $idcol, $idval, $keys, $args) = _getRestParams($request);
+
+
+	my $names = join ', ', @$keys;
+	my $questions = join ', ', map { '?' } @$keys;
+
+	my $sql = "INSERT INTO $table( $names ) VALUES ($questions)";
+
+writeDebug($sql . join ',', @$args);
+	my $sth = Foswiki::Plugins::SqlPlugin::execute($dbconn, $sql, @$args);
+	$sth->finish;
+
+#	cleanPageCache($table);
+
+	return "1";
+}
+
+#sub cleanPageCache {
+#	my $table = $_[0];
+
+
+#}
+
+1;
+
+__END__

lib/Foswiki/Plugins/SqlGridPlugin/DEPENDENCIES

@@ -0,0 +1,5 @@
+# Dependencies for SqlGridPlugin
+# Example:
+# Time::ParseDate,>=2003.0211,cpan,Required.
+# Foswiki::Plugins,>=1.2,perl,Requires version 1.2 of handler API.
+

lib/Foswiki/Plugins/SqlGridPlugin/Debug.pm

@@ -0,0 +1,6 @@
+package Foswiki::Plugins::SqlGridPlugin::Debug;
+
+use Foswiki::Func    ();
+
+
+1;

lib/Foswiki/Plugins/SqlGridPlugin/MANIFEST

@@ -0,0 +1,8 @@
+# Release manifest for SqlGridPlugin
+data/System/SqlGridPlugin.txt 0644 Documentation
+data/System/SqlGridPluginDialogs.txt 0644 Documentation
+lib/Foswiki/Plugins/SqlGridPlugin.pm 0444 Perl module
+lib/Foswiki/Plugins/SqlGridPlugin/SqlParser.pm 0444 Perl module
+lib/Foswiki/Plugins/SqlGridPlugin/SqlConnector.pm 0444 Perl module
+lib/Foswiki/Plugins/SqlGridPlugin/SqlMysqlConnector.pm 0444 Perl module
+pub/System/SqlGridPlugin/gridfuncs.js 0444 Javascript