util.php File Reference

Utility functions. More...

Go to the source code of this file.

Functions
	db_query_mysql ($link, $q, $kw)
	perform a database query
	link_maybe ($text, $url, $condition)
	conditionally print text as a HTML hyperlink
	redirect ($url)
	redirect the user to a different URL
	param_ok ($allowed, $k, $v)
	check a parameter
	print_table ($table, $cols, $attr, $dblink, $subst)
	print a HTML table from a template
	normalize_input ($v)
	normalize user input
	print_header ($kw)
	print_footer ($kw)
	db_error_mysql ()
	handle MySQL database errors
	error_msg ($msg)

---

Detailed Description

Utility functions.

Definition in file util.php.

---

Function Documentation

db_error_mysql

(

)

handle MySQL database errors

determine the cause of error, print an appropriate error message, and exit

Definition at line 271 of file util.php.

References error_msg().

Referenced by db_query_mysql().

                          {
        error_msg( "MYSQL: " . mysql_error() . " [" . mysql_errno() . "]" ); 
        exit(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

db_query_mysql	(	$	link,
		$	q,
		$	kw
	)

perform a database query

Parameters:

	$link	open handle to the database
	$q	the SQL query
	$kw	text substitutions to be performed on $q

Before the query is performed, the associative array $kw[] is consulted, and each occurence of $key in the query is substituted by $kw[$key]. Proper quotation is applied to the substitution text so that it is safe to have special characters (e.g. hyphens) in it.

Returns:

an array where each element is a sub-array representing a row of the query result. Each sub-array has the format delivered by mysql_fetch_array().

Note:

All queries to the MySQL database are done through this function.

Definition at line 32 of file util.php.

References $kw, $link, $q, $r, $v, and db_error_mysql().

Referenced by check_for_doubles(), export_to_pica(), fields_init(), and print_table().

                                        {

        foreach ($kw as $k => $v) {
                $kw[$k] = mysql_escape_string($v);
        }

        $q = strtr($q, $kw);

        // print "query: " . $q . "<br>";

        ($r = @ mysql_query($q, $link)) or db_error_mysql();
        
        $result = array(); $i = 1;
                
        if (@ mysql_num_rows($r) > 0)  {
                while ($row = @ mysql_fetch_array($r))  {
                        $result[$i++] = $row;           
                }
        }

        return $result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

link_maybe	(	$	text,
		$	url,
		$	condition
	)

conditionally print text as a HTML hyperlink

Parameters:

$text,$url,$condition

see below

This function prints a given $text. If $condition is true, $text is made into a hyperlink pointing to $url.

Returns:

nothing

Definition at line 63 of file util.php.

References print.

                                             {
        if ($condition) 
                print "<a href=\"$url\">$text</a>";
        else
                print "<strong>$text</strong>";
}

normalize_input

(

$

v

)

normalize user input

This function tries to deal with funny characters in user input by replacing them with harmless ones. It also strips blanks that are deemed unnecessary.

Parameters:

$v

user input

Returns:

normalized user input

Definition at line 233 of file util.php.

References $v.

                             {
        $v = preg_replace("/\\s+/", " ", $v);
        $v = preg_replace("/^ /", "", $v);
        $v = preg_replace("/ $/", "", $v);

        $v = strtr($v, 'ÀÁÂÃÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕØÙÚÛÝàáâãåæçèéêëìíîïñòóôõøùúûýÿ',
                       'AAAAAACEEEEIIIIDNOOOOOUUUYaaaaaaceeeeiiiinooooouuuyy');

        return $v;      
}

param_ok	(	$	allowed,
		$	k,
		$	v
	)

check a parameter

This function is used to determine whether input to a script (received via GET or POST request) should be accepted by the script.

For example, to check whether $_GET['foo'] contains valid data you would test if param_ok($allowed, 'foo', $_GET['foo']) yields TRUE.

Parameters:

	$allowed	is an associative array containing regular expressions against which the input is matched
	$k	is a key into the $allowed[] array
	$v	is the input value to be checked

Returns:

TRUE if the value should be accepted, FALSE otherwise.

Definition at line 113 of file util.php.

References $v.

                                    {

        $ok = TRUE;

        if (!isset($allowed[$k]))
                $ok = FALSE;
        else if (!preg_match($allowed[$k], $v))
                $ok = FALSE;

        return $ok;

}

print_table	(	$	table,
		$	cols,
		$	attr,
		$	dblink,
		$	subst
	)

print a HTML table from a template

This function prints a HTML table from a template. See $table1 ... $table4 in action.php for examples of such templates.

Parameters:

	$table	the template
	$dblink	an open handle to the MySQL database
	$cols	the desired number of columns in the table
	$attr	the attributes of the HTML table (e.g. 'border="0"')
	$subst	a substitution table for db_query_mysql()

Returns:

nothing

Definition at line 139 of file util.php.

References $_SESSION, $f, $fields, $r, $v, db_query_mysql(), input_control(), and print.

                                                            {
        
        print "<table width=\"100%\" " . $attr . " >\n<tr>\n";

        $c = 1;

        // $col_width1 = (35 / $cols);
        // $col_width2 = (65 / $cols);

        if (empty($table))
                return(TRUE);

        foreach ($table as $row ) {

                // do SQL query


                if (isset ($row["value"])) {

                        print "<td width=\"30%\"><strong>" . $row["label"] ;
                        print "</strong></td>\n" ;      
                        print "<td>" . htmlentities(strtr($row["value"], $subst)) . "</td>";

                } else if (isset ($row["query"])) {
                
                        $r = db_query_mysql($dblink, $row["query"] , $subst);

                        if (empty($r))  {
                                print "<td>&nbsp;</td>\n"; 
                                print "<td>&nbsp;</td>\n"; 
                        } else {

                                print "<td width=\"30%\"><strong>";
                                print   $row["label"] . "</strong></td>\n";

                                print "<td>";

                                foreach ($r[1] as $k => $v)  {
                                        if (is_numeric($k)) 
                                                print htmlentities($v) . "&nbsp;";
                                }               
                        
                                print "&nbsp;</td>\n";
                        }
                } else if (isset($row["fields"])) {
                        global $fields;

                        // print label

                        print "<td><strong>" . $row["label"] ;
                        print "</strong></td>\n" ;      

                        // print html form for user input

                        print "<td>";

                        foreach ($row["fields"] as $f) {        

                                // field key, field value
                                $fk = $f;
                                $fv = (isset($_SESSION[$fk])) ? 
                                        $_SESSION[$fk] : "";

                                print input_control($f, $fk, $fv ); 
                                print "&nbsp;&nbsp;";
                        }
                        print "</td>\n"; 
        
                } else {
                        print "<td>&nbsp;</td>\n"; 
                        print "<td>&nbsp;</td>\n"; 
                }

                if ($c < $cols){
                        $c++;
                } else {
                        print "</tr>\n<tr>\n";
                        $c = 1;
                }               
        }

        print "</tr></table>";

}

Here is the call graph for this function:

redirect

(

$

url

)

redirect the user to a different URL

Parameters:

$url

target url

This function redirects the browser to a different URL.

Returns:

nothing

Definition at line 77 of file util.php.

References $kw, $text, $url, print, print_footer(), and print_header().

                        {
        global $text;

        $kw = array ('@bodyattr@' => "",
                     '@notabene@' => "", 
                     '@url@' => "$url",
                     '@url-de@' => "$url",
                     '@url-en@' => "$url");

        header("Location: " . $url);
        
        // for older browsers that don't support redirect

        print_header($kw);
        print strtr($text['redirect'], $kw);
        print_footer($kw);
        exit(0);
}

Here is the call graph for this function:

---