--- loncom/interface/lonmysql.pm 2002/07/30 18:26:40 1.3
+++ loncom/interface/lonmysql.pm 2003/03/17 18:35:51 1.11
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# MySQL utility functions
#
-# $Id: lonmysql.pm,v 1.3 2002/07/30 18:26:40 matthew Exp $
+# $Id: lonmysql.pm,v 1.11 2003/03/17 18:35:51 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -71,17 +71,18 @@ To create a table, you need a descriptio
for &create_table for a description of what is needed.
$table_id = &create_table({
- columns => {
- id => {
- type => 'INT',
- restrictions => 'NOT NULL',
- primary_key => 'yes',
- auto_inc => 'yes'
- }
- verbage => { type => 'TEXT' },
- },
- column_order => [qw/id verbage idx_verbage/],
- fulltext => [qw/verbage/],
+ id => 'tableid', # usually you will use the returned id
+ columns => (
+ { name => 'id',
+ type => 'INT',
+ restrictions => 'NOT NULL',
+ primary_key => 'yes',
+ auto_inc => 'yes'
+ },
+ { name => 'verbage',
+ type => 'TEXT' },
+ ),
+ fulltext => [qw/verbage/],
});
The above command will create a table with two columns, 'id' and 'verbage'.
@@ -230,6 +231,10 @@ an array reference which holds the order
The statement handler for row inserts.
+=item row_replace_sth
+
+The statement handler for row inserts.
+
=back
Col_order and row_insert_sth are kept internally by lonmysql and are not
@@ -327,7 +332,10 @@ sub connect_to_db {
$Apache::lonnet::perlvar{'lonSqlAccess'},
{ RaiseError=>0,PrintError=>0}))) {
$debugstring = "Unable to connect to loncapa database.";
- if ($dbh->err) {
+ if (! defined($dbh)) {
+ $debugstring = "Unable to connect to loncapa database.";
+ $errorstring = "dbh was undefined.";
+ } elsif ($dbh->err) {
$errorstring = "Connection error: ".$dbh->errstr;
}
return undef;
@@ -359,6 +367,9 @@ sub disconnect_from_db {
if (exists($Tables{$_}->{'row_insert_sth'})) {
delete($Tables{$_}->{'row_insert_sth'});
}
+ if (exists($Tables{$_}->{'row_replace_sth'})) {
+ delete($Tables{$_}->{'row_replace_sth'});
+ }
}
$dbh->disconnect if ($dbh);
$debugstring = "Disconnected from database.";
@@ -385,6 +396,26 @@ sub number_of_rows {
return undef if (! defined(&update_table_info($table_id)));
return $Tables{&translate_id($table_id)}->{'Rows'};
}
+###############################
+
+=pod
+
+=item &get_dbh()
+
+Input: nothing
+
+Returns: the database handler, or undef on error.
+
+This routine allows the programmer to gain access to the database handler.
+Be careful.
+
+=cut
+
+###############################
+sub get_dbh {
+ return undef if (! defined(&connect_to_db()));
+ return $dbh;
+}
###############################
@@ -424,7 +455,7 @@ sub get_debug {
=pod
-=item &update_table_info($table_id)
+=item &update_table_info()
Inputs: table id
@@ -481,7 +512,7 @@ sub update_table_info {
# Determine the column order
#
$db_command = "DESCRIBE $tablename";
- my $sth = $dbh->prepare($db_command);
+ $sth = $dbh->prepare($db_command);
$sth->execute();
if ($sth->err) {
$errorstring = "$dbh ATTEMPTED:\n".$db_command."\nRESULTING ERROR:\n".
@@ -504,7 +535,7 @@ sub update_table_info {
=pod
-=item &create_table
+=item &create_table()
Inputs:
table description
@@ -513,17 +544,32 @@ Input formats:
table description = {
permanent => 'yes' or 'no',
- columns => {
- colA => {
- type => mysql type,
- restrictions => 'NOT NULL' or empty,
- primary_key => 'yes' or empty,
- auto_inc => 'yes' or empty,
- }
- colB => { .. }
- colZ => { .. }
- },
- column_order => [ colA, colB, ..., colZ],
+ columns => [
+ { name => 'colA',
+ type => mysql type,
+ restrictions => 'NOT NULL' or empty,
+ primary_key => 'yes' or empty,
+ auto_inc => 'yes' or empty,
+ },
+ { name => 'colB',
+ ...
+ },
+ { name => 'colC',
+ ...
+ },
+ ],
+ 'PRIMARY KEY' => (index_col_name,...),
+ KEY => [{ name => 'idx_name',
+ columns => (col1,col2,..),},],
+ INDEX => [{ name => 'idx_name',
+ columns => (col1,col2,..),},],
+ UNIQUE => [{ index => 'yes',
+ name => 'idx_name',
+ columns => (col1,col2,..),},],
+ FULLTEXT => [{ index => 'yes',
+ name => 'idx_name',
+ columns => (col1,col2,..),},],
+
}
Returns:
@@ -540,12 +586,18 @@ sub create_table {
##################################
my @Columns;
my $col_des;
- my $table_id = &get_new_table_id();
+ my $table_id;
+ if (exists($table_des->{'id'})) {
+ $table_id = $table_des->{'id'};
+ } else {
+ $table_id = &get_new_table_id();
+ }
my $tablename = &translate_id($table_id);
my $request = "CREATE TABLE IF NOT EXISTS ".$tablename." ";
- foreach my $column (@{$table_des->{'column_order'}}) {
+ foreach my $coldata (@{$table_des->{'columns'}}) {
+ my $column = $coldata->{'name'};
+ next if (! defined($column));
$col_des = '';
- my $coldata = $table_des->{'columns'}->{$column};
if (lc($coldata->{'type'}) =~ /(enum|set)/) { # 'enum' or 'set'
$col_des.=$column." ".$coldata->{'type'}."('".
join("', '",@{$coldata->{'values'}})."')";
@@ -570,9 +622,39 @@ sub create_table {
# skip blank items.
push (@Columns,$col_des) if ($col_des ne '');
}
- if (exists($table_des->{'fulltext'})) {
- push (@Columns,'FULLTEXT ('.join(',',@{$table_des->{'fulltext'}}).')');
+ if (exists($table_des->{'PRIMARY KEY'})) {
+ push (@Columns,'PRIMARY KEY ('.join(',',@{$table_des->{'PRIMARY KEY'}})
+ .')');
+ }
+ #
+ foreach my $indextype ('KEY','INDEX') {
+ next if (!exists($table_des->{$indextype}));
+ foreach my $indexdescription (@{$table_des->{$indextype}}) {
+ my $text = $indextype.' ';
+ if (exists($indexdescription->{'name'})) {
+ $text .=$indexdescription->{'name'};
+ }
+ $text .= ' ('.join(',',@{$indexdescription->{'columns'}}).')';
+ push (@Columns,$text);
+ }
+ }
+ #
+ foreach my $indextype ('UNIQUE','FULLTEXT') {
+ next if (! exists($table_des->{$indextype}));
+ foreach my $indexdescription (@{$table_des->{$indextype}}) {
+ my $text = $indextype.' ';
+ if (exists($indexdescription->{'index'}) &&
+ $indexdescription->{'index'} eq 'yes') {
+ $text .= 'INDEX ';
+ }
+ if (exists($indexdescription->{'name'})) {
+ $text .=$indexdescription->{'name'};
+ }
+ $text .= ' ('.join(',',@{$indexdescription->{'columns'}}).')';
+ push (@Columns,$text);
+ }
}
+ #
$request .= "(".join(", ",@Columns).") ";
unless($table_des->{'permanent'} eq 'yes') {
$request.="COMMENT = 'temporary' ";
@@ -600,7 +682,7 @@ sub create_table {
=pod
-=item &get_new_table_id
+=item &get_new_table_id()
Used internally to prevent table name collisions.
@@ -609,7 +691,6 @@ Used internally to prevent table name co
###############################
sub get_new_table_id {
my $newid = 0;
- my $name_regex = '^'.$ENV{'user.name'}.'_'.$ENV{'user.domain'}."_(\d+)\$";
my @tables = &tables_in_db();
foreach (@tables) {
if (/^$ENV{'user.name'}_$ENV{'user.domain'}_(\d+)$/) {
@@ -623,7 +704,7 @@ sub get_new_table_id {
=pod
-=item &get_rows
+=item &get_rows()
Inputs: $table_id,$condition
@@ -646,7 +727,13 @@ sub get_rows {
return undef;
}
my $tablename = &translate_id($table_id);
- my $request = 'SELECT * FROM '.$tablename.' WHERE '.$condition;
+ my $request;
+ if (defined($condition) && $condition ne '') {
+ $request = 'SELECT * FROM '.$tablename.' WHERE '.$condition;
+ } else {
+ $request = 'SELECT * FROM '.$tablename;
+ $condition = 'no condition';
+ }
my $sth=$dbh->prepare($request);
$sth->execute();
if ($sth->err) {
@@ -657,11 +744,6 @@ sub get_rows {
}
$debugstring = "Got rows matching $condition";
my @Results = @{$sth->fetchall_arrayref};
- foreach my $row (@Results) {
- for(my $i=0;$i<@$row;$i++) {
- $row->[$i]=&Apache::lonnet::unescape($row->[$i]);
- }
- }
return @Results;
}
@@ -669,7 +751,7 @@ sub get_rows {
=pod
-=item &store_row
+=item &store_row()
Inputs: table id, row data
@@ -711,7 +793,7 @@ sub store_row {
@Parameters = @$rowdata;
} elsif (ref($rowdata) eq 'HASH') {
foreach (@{$Tables{$tablename}->{'Col_order'}}) {
- push(@Parameters,&Apache::lonnet::escape($rowdata->{$_}));
+ push(@Parameters,$rowdata->{$_});
}
}
$sth->execute(@Parameters);
@@ -724,11 +806,72 @@ sub store_row {
return 1;
}
+###############################
+
+=pod
+
+=item &replace_row()
+
+Inputs: table id, row data
+
+returns undef on error, 1 on success.
+
+Acts like &store_row() but uses the 'REPLACE' command instead of 'INSERT'.
+
+=cut
+
+###############################
+sub replace_row {
+ my ($table_id,$rowdata) = @_;
+ #
+ return undef if (! defined(&connect_to_db()));
+ my $table_status = &check_table($table_id);
+ return undef if (! defined($table_status));
+ if (! $table_status) {
+ $errorstring = "table $table_id does not exist.";
+ return undef;
+ }
+ #
+ my $tablename = &translate_id($table_id);
+ #
+ my $sth;
+ if (exists($Tables{$tablename}->{'row_replace_sth'})) {
+ $sth = $Tables{$tablename}->{'row_replace_sth'};
+ } else {
+ # Build the insert statement handler
+ return undef if (! defined(&update_table_info($table_id)));
+ my $replace_request = 'REPLACE INTO '.$tablename.' VALUES(';
+ foreach (@{$Tables{$tablename}->{'Col_order'}}) {
+ $replace_request.="?,";
+ }
+ chop $replace_request;
+ $replace_request.=")";
+ $sth=$dbh->prepare($replace_request);
+ $Tables{$tablename}->{'row_replace_sth'}=$sth;
+ }
+ my @Parameters;
+ if (ref($rowdata) eq 'ARRAY') {
+ @Parameters = @$rowdata;
+ } elsif (ref($rowdata) eq 'HASH') {
+ foreach (@{$Tables{$tablename}->{'Col_order'}}) {
+ push(@Parameters,$rowdata->{$_});
+ }
+ }
+ $sth->execute(@Parameters);
+ if ($sth->err) {
+ $errorstring = "$dbh ATTEMPTED replace @Parameters RESULTING ERROR:\n".
+ $sth->errstr;
+ return undef;
+ }
+ $debugstring = "Stored row.";
+ return 1;
+}
+
###########################################
=pod
-=item tables_in_db
+=item &tables_in_db()
Returns a list containing the names of all the tables in the database.
Returns undef on error.
@@ -738,7 +881,7 @@ Returns undef on error.
###########################################
sub tables_in_db {
return undef if (!defined(&connect_to_db()));
- my $sth=$dbh->prepare('SHOW TABLES;');
+ my $sth=$dbh->prepare('SHOW TABLES');
$sth->execute();
if ($sth->err) {
$errorstring = "$dbh ATTEMPTED:\n".'SHOW TABLES'.
@@ -758,7 +901,7 @@ sub tables_in_db {
=pod
-=item &translate_id
+=item &translate_id()
Used internally to translate a numeric table id into a MySQL table name.
If the input $id contains non-numeric characters it is assumed to have
@@ -781,7 +924,9 @@ sub translate_id {
=pod
-=item &check_table($id)
+=item &check_table()
+
+Input: table id
Checks to see if the requested table exists. Returns 0 (no), 1 (yes), or
undef (error).
@@ -797,7 +942,7 @@ sub check_table {
my @Table_list = &tables_in_db();
my $result = 0;
foreach (@Table_list) {
- if (/^$table_id$/) {
+ if ($_ eq $table_id) {
$result = 1;
last;
}
@@ -808,6 +953,45 @@ sub check_table {
return $result;
}
+###########################################
+
+=pod
+
+=item &remove_from_table()
+
+Input: $table_id, $column, $value
+
+Returns: the number of rows deleted. undef on error.
+
+Executes a "delete from $tableid where $column like binary '$value'".
+
+=cut
+
+###########################################
+sub remove_from_table {
+ my ($table_id,$column,$value) = @_;
+ return undef if (!defined(&connect_to_db()));
+ #
+ $table_id = &translate_id($table_id);
+ my $command = 'DELETE FROM '.$table_id.' WHERE '.$dbh->quote($column).
+ " LIKE BINARY ".$dbh->quote($value);
+ my $sth = $dbh->prepare($command);
+ $sth->execute();
+ if ($sth->err) {
+ $errorstring = "ERROR on execution of ".$command."\n".$sth->errstr;
+ return undef;
+ }
+ my $rows = $sth->rows;
+ return $rows;
+}
+
+
1;
__END__;
+
+=pod
+
+=back
+
+=cut