File Source for csv_loader

<?php
/**
* CSV loader.
* This file contains the CSV loader.
* @package HRDIODB
*/
/**
* This file is part of HRDIODB.
*
* HRDIODB 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.
*
* HRDIODB 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.
*
* You should have received a copy of the GNU General Public License
* along with HRDIODB; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/** Configuration file */
require_once("conf.php");
/** Debugging functions */
require_once("debugging.php");
/**
* A class for loading a CSV file into the database.
* The {@link csv_loader} class requires a table name, a unique key name and
* a CSV file where the first line that is not a comment is a comma separated
* list of field names. Each following non comment line is a comma separated
* list of values for those fields. Comments are denoted by the # sign.
* @package HRDIODB
*/
class csv_loader {
/**
* Constructor.
* Class constructor.
*/
function csv_loader () {
$this->comments = array();
$this->data_lines = array();
$this->filename = "none";
$this->parsed = FALSE;
$this->group = 0;
}
/******* Set functions ********/
/**
* Sets the database object.
* Sets the database object. Requires a {@link hrdi_db} object.
* @param hrdi_db $db The reference to a hrdi_db object
*/
function set_db (&$db) {
$this->db = $db;
}
/**
* Creates a file handle.
* Takes a file name and creates a file handle.
* @param string $file Filename
*/
function set_file ($file) {
$this->filename = $file;
$this->handle = fopen($file, "r");
}
/**
* Sets table name.
* Sets the destination table name.
* @param string $table Table name
*/
function set_table ($table) {
$this->table = $table;
}
/**
* Sets the table / key array.
* Sets an associative array of unique keys to be used to determine if data
* exists in a table.
* @param array $table_keys Table keys array
*/
function set_table_keys ($table_keys) {
$this->table_keys = $table_keys;
}
/**
* Sets field.
* Sets a field to the input line. Takes an array of the target database
* fields.
* @param string $line A single CSV formatted line containing only field names
*/
function set_fields ($line) {
foreach($line as $field) {
$trimmed[] = trim($field);
}
$table = @$this->data_lines[$this->group]['table'];
if(!$table){
error("A table must be set before fields are specified");
exit(0);
}
// Check the fields' validity
$dbfields = $this->db->get_field_names($table);
foreach ($trimmed as $t) {
if (!in_array($t, $dbfields)) {
error("'$t' is not a field in the table '$table'");
exit(0);
}
}
$this->fields = $trimmed;
}
/**
* Parses the file.
* Parses all the lines of the object's file.
*/
function parse_file() {
while (($this->load_csv_line()) !== FALSE) { }
$this->parsed = TRUE;
}
/**
* Reads one csv line into an array.
* Performs cleaning actions on the data from the CSV.
* @return mixed Cleaned data
*/
function get_line() {
global $csv_line_character_limit;
$line = fgetcsv($this->handle, $csv_line_character_limit, ",");
//Trim spaces from the line if the line is an array
if (is_array($line)) {
foreach ($line as $item) {
$trimmed[] = trim($item);
}
// If a line is blank then read ahead to the next line
if(count($line)==1 && $line[0] == ""){
return $this->get_line();
}
return $trimmed;
}
return $line;
}
/**
* Parses one line of a CSV file.
* Determines if that line is a comment, the list of fields, or the data.
* @return mixed Line of data or FALSE.
*/
function load_csv_line(){
$line = $this->get_line();
if ($line[0][0] == '#') {
$this->comments[] = $line;
return 0;
}
if ($line === FALSE) {
return FALSE;
}
// Detect a table header
if(strtolower($line[0]) == "table"){
if(count($line) != 1){
error("Bad table header: ".implode($line));
exit(0);
}
//A table header was found, read ahead to get the table name
$next_line = $this->get_line();
if(count($next_line) != 1){
error("Bad table name: ".implode($next_line, ", "));
exit(0);
}
//Create a new array with an entry describing the table
$this->group++;
$dbfields = $this->db->get_field_names($next_line[0]);
if(!$dbfields){
// Error is given by db class
exit(0);
}
$this->data_lines[$this->group]['table'] = $next_line[0];
return TRUE;
}
// Detect a field header
if (strtolower($line[0]) == "fields") {
if (count($line) != 1) {
error("Bad field header: ".implode($line));
exit(0);
}
$next_line = $this->get_line();
//Create a new array with an entry describing the fields
$this->set_fields($next_line);
return TRUE;
}
// Check to see if we have fields
if (!isset($this->fields)) {
error("No fields declaration found");
exit(0);
}
// Check for mismatched field and line element numbers
if (count($this->fields) != count($line)) {
error("Wrong number of fields supplied:\nRequired:\t".
implode($this->fields, ", ")."\nActual: \t".
implode($line, ", "));
exit(0);
}
if (trim($line[0]) != "") {
//You can use following function instead in php 5
//$combined = array_combine($this->data_lines[$this->group]['fields'], $line);
$i = 0;
foreach($this->fields as $field){
$combined[$field] = $line[$i];
$i++;
}
$this->data_lines[$this->group][] = $combined;
}
return $line;
}
/**
* Prints file information.
* Prints detailed information about a parsed file.
*/
function print_file_info() {
if (!$this->parsed) {
error("Must parse first");
return 0;
}
print "\tFilename: ".$this->filename;
print "\n\tComment lines: ".count($this->comments);
print "\n\tBlocks: ".count($this->data_lines);
print "\n";
foreach($this->data_lines as $block){
print "\n\tTable: ".@$block['table'];
print "\n\tData lines: ".(count($block) - 1);
print "\n";
}
print "\n";
foreach ($this->comments as $comment){
$comment = implode($comment);
print "\n$comment";
}
print "\n";
}
/**
* Pushes information to the database.
* Pushes parsed file information to the database.
*/
function push_to_db () {
$added = $updated = 0;
print "\nUploading:";
foreach ($this->data_lines as $block){
if(!isset($block['table'])){
error("Table not set");
exit(0);
}
$table = $block['table'];
unset($block['table']);
// Set the key from the table_keys array
unset($key);
if(isset($this->table_keys[$table])){
$key = $this->table_keys[$table];
}
foreach($block as $record){
$where = addslashes(@$record[$key]);
// Test for update or add.
// Only do update check if a key exists for this table
$sql = "SELECT $key
FROM $table
WHERE $key='$where'";
if (isset($key) && isset($record[$key]) && $this->db->get_one($sql)) {
// update
$this->db->update($record, $table, $key);
$updated++;
} else {
// add
$this->db->add($record, $table);
$added++;
}
print(".");
}
}
print "\n\n\tRecords added: $added";
print "\n\tRecords updated: $updated";
print "\n\n";
}
}
?>

Source for file csv_loader_class.php