data_import_manager.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2007-2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
require_once realpath(dirname(__FILE__))."/data_view.inc";
 
class DataImportManager
{
     var $class_name;              
     var $id;
     var $log;
     var $objs = array();          
     var $import = false;
     var $preview = false;         
     var $matches = array();       
     var $savedObjs = array();     
     var $onPreProcessRow = null;  
     var $filepath = null;         
     var $validateDataFile;        
     var $buttons = array();       
     var $onSaveComplete = null;   
     var $field = "csv_file";
     var $cssClass = "";
     var $table;
     var $quiet = false; 
     
     function __construct($class_name, $id = "")
     {    
          $this->class_name = $class_name;
          $this->id = ($id) ? $id : codify(strtolower($this->class_name)) . "_data_import";
          
          if($_POST["import"])
          {
               $this->import = true;
          }
     }
     
     function column($field, $position, $label = "", $options = array(), $importer = "", $update_empty = true)
     {
          if(!$label)
          {
               $obj = new $this->class_name;
               $label =  $obj->prettifyFieldName($field);
          }
          $this->columns[] = new DataImportColumn($field, $position, $label, $options, $importer, $update_empty);
          
          return $this;
     }    
     
     function additional($field, $label = "", $template = "", $update_empty)
     {
          if(!$label)
          {
               $obj = new $this->class_name;
               $label =  $obj->prettifyFieldName($field);
          }
          $this->columns[] = new DataImportColumn($field, 0, $label, null, $template, $update_empty);
          
          return $this;
     }
     
     function match()
     {
          foreach(func_get_args() as $field)
          {
               $this->matches[$field] = true;
          }
     }
     
     function formatList($items, $nameField)
     {
          if(count($items) == 0)
          {
               return array();
          }
          
          $out = array();
          foreach($items as $item)
          {
               $pk = $item->getPrimaryKey();
               $out[$item->$pk] = $item->$nameField;
          }
          
          return $out;
     }
          
     function import()
     {
          $fp = $this->openFile();      
          if(!$fp) return;
          
          if($this->loadData($fp))
          {
               $this->save();
               if (!$this->quiet)
               {
                    $this->drawButtons();
                    $this->writeLog();
               }
          }
     }
     
     function button($text, $url, $confirm = null, $isScript = false)
     {
          $this->buttons[] = array('text' => $text, 'url' => $url, 'confirm' => $confirm, 'isScript' => $isScript);
     }    
     
     function loadData($fp)
     {
          trace("Loading Data...", 3);
          
          // Use for indexing warnings
          $row_number = 1;
          $first = true;
          $read = 0;
          
          while (($row = fgetcsv($fp)) !== FALSE)
          {
               $read++;
               if($first && $this->validateDataFile && !call_user_func($this->validateDataFile, $row))
               {
                    return false;
               }
               $first = false;
               $obj = $this->importOneRow($row, $row_number);
               if($obj)
               {
                    $this->objs[$obj->row_number] = $obj;
                    $row_number++;
               }
          }    
          
          trace("Read {$row_number} objects from {$read} rows", 3);
          return true;
     }
          
     function log($text)
     {
          $this->log .= $text . "</br></br>";
     }
     
     function writeLog()
     {
          if (!$this->quiet) echo $this->log;
     }
     
     function importOneRow($row, $row_number)
     {
          $class_name = $this->class_name;
          $obj = new $class_name;
          
          $this->init($obj, $row_number);
     
          foreach($this->columns as $column)
          {
               $position = $column->position;
               if($position == 0) continue;
               $this->importCell($column, $obj, $row[$position-1]);
          }
          
          // Load additional columns after in case their value depends on rows
          // loaded from spreadsheet
          foreach($this->columns as $column)
          {
               if($column->position > 0) continue;
               $this->importCell($column, $obj, 0);    
          }
                    
          $obj = $this->preProcessRow($obj);
          
          return $obj;
     }
     
     function preProcessRow($obj)
     {
          if(count($this->matches))
          {
               $savedObj = $this->findMatch($obj);
               if($savedObj)
               {              
                    $pk = $this->getPrimaryKey();
                    $this->savedObjs[$savedObj->$pk] = $savedObj;
                    $obj->$pk = $savedObj->$pk;
                    $this->setFilter($obj, $savedObj);
                    if(!$obj->getFilter()) return null;     
               }
          }
          
          if ($this->onPreProcessRow)
          {
               call_user_func($this->onPreProcessRow, $obj, $savedObj);
          }
     
          return $obj;
     }
     
     function getSavedObj($obj)
     {
          $pk = $this->getPrimaryKey();
     
          if(array_key_exists($obj->$pk, $this->savedObjs))
          {
               return $this->savedObjs[$obj->$pk];
          }
          
          return null;
     }
     
     function findMatch($obj)
     {
          if(!count($this->matches))
          {
               return null;
          }
 
          foreach($this->matches as $field => $dump)
          {
               $constraint[] = $field . "=:$field";
          }
          
          $query = Query::create($this->class_name, "WHERE " . implode(" AND ", $constraint));
          
          foreach($this->matches as $field => $dump)
          {
               $query->bind(":$field", $obj->$field);
          }
          
          $foundObjs = $query->execute();
 
          return (count($foundObjs)) ? $foundObjs[0] : null;
     }
     
     function setFilter($obj, $old)
     {
          $fields = $obj->getFields();
          $changed = false;
     
          $obj->filter = new InclusionFilter();
          $old->filter = new InclusionFilter();
          foreach($fields as $field => $type)
          {
               $column = $this->getColumn($field);
               if(!$column) continue;
               $value = $obj->$field;
               if(($value || $column->update_empty) && $obj->$field != $old->$field)
               {
                    $changed = true;
                    $obj->filter->add($field);
                    $old->filter->add($field);
               }
          }
     
          if(!$changed)
          {
               $obj->filter = null;
               $old->filter = null;
          }
     }
     
     function getColumn($field)
     {
          if(!count($this->columns)) return false;
          
          if(count($this->columns))
          {
               foreach($this->columns as $column)
               {
                    if($column->field == $field)
                    {
                         return $column;
                    }
               }
          }
               
          return null;
     }
     
     /*
      * Initialize any fields that may not get a value
      * in the import.
      * 
      * e.g. set user_id, date_created, etc.
      */
     function init(&$obj, $row_number)
     {
          // use for indexing           
          $obj->set("row_number", $row_number);
     }
     
     function save()
     {
          if(count($this->objs) == 0)
          {
               return;
          }
 
          foreach($this->objs as $row_number => $obj)
          {
               $pk = $this->getPrimaryKey();
               $new = false;
               
               if(!$obj->$pk)
               {
                    $new = true;
               }
               $obj->save();
               $this->log($this->formatSaveLogText($row_number, $obj, $new));
          }
 
          if ($this->onSaveComplete)
          {
               call_user_func_array($this->onSaveComplete, array($this));
          }
          
          return true;
     }
     
     function formatSaveLogText($row_number, $obj, $new)
     {
          $pk = $this->getPrimaryKey();
          $name = $this->getClassName();
          $fields = $obj->getFields();
          $out = array();
          
          if(!$new)
          {
               $filter = $obj->getFilter();
               foreach($fields as $field => $type)
               {
                    if($filter && !$filter->isExcluded($field))
                    {
                         $out[] = $field . " " . $obj->$field;
                    }
               }
               $text = "<b>Updated</b> $name from row number $row_number $pk {$obj->$pk} " . implode(" ", $out);
          }
          else
          {
               foreach($fields as $field => $type)
               {
                    $out[] = $field . " " . $obj->$field;
               }
                    
               $text = "<b>Inserted</b> into $name from row number $row_number $pk {$obj->$pk} " . implode(" ", $out);
          }
          
          foreach($this->columns as $column)
          {
               $warning = $column->getWarning($obj);
               if($warning)
               {
                    $text .= "<span class='warning'>{$warning}</warning>";
               }
          }
          
          return $text;
     }
          
     function getPrimaryKey()
     {
          $class_name = $this->class_name;
          $obj = new $class_name;
          return $obj->getPrimaryKey();
     }
     
     function getClassName()
     {
          $class_name = $this->class_name;
          $obj = new $class_name;
          return $obj->prettifyClassName();  
     }
          
     function buildInputTable()
     {
          $table = new DataListView($this->columns, $this->id);
          $table->column("Column Name", "{field}")
               ->column("Title/Label", "{label}")
               ->column("Options", "{formatOptions()}")
               ->column("Position", "{position}")
               ;
          
          $table->sortable = false;
          $table->paginate = false;
          $table->filter = false;
          
          return $table;
     }
     
     function writeScript()
     {
          return "";
     }
     
     function drawView()
     {
          $file = $this->getFilePath();
          
          $class = ($this->cssClass) ? " class='{$this->cssClass}'" : "";
          echo "<div id='data_import'{$class}>\n";
          
          if(!$file)
          {
               $this->drawForm();
          }
          else if(!$this->import)
          {
               $this->preview();
          }
          else 
          {
               $this->import();
          }
          echo "</div>\n";
     }
     
     function preview()
     {
          $this->preview = true;
          $this->uploadDataImportFile();
 
          $fp = $this->openFile();
          if(!$fp) return;
          
          if($this->loadData($fp))
          {
               $this->table = $this->buildPreviewTable();
          }
          
          if(count($this->table->items))
          {
               echo "<form method='POST' action='' enctype='multipart/form-data'>\n";
               echo "<input type='hidden' name='{$this->field}' value='{$this->filepath}'/>\n";
               $this->drawButtons();
          }
          
          echo $this->log;
          $this->table->drawView();
          
          if(!count($this->table->items) && !$this->filepath)
          {
               $this->drawForm();
          }
 
          $this->drawButtons();
          
          if(count($this->table->items))
          {
               echo "</form>\n";
          }
     }
     
     function drawForm()
     {
          $table = $this->buildInputTable();
          echo "<p><label>Description of columns expected in import file:</label></p>\n";
          $table->drawView();
          
          echo "</br></br><form method='POST' action='' enctype='multipart/form-data'>
          <label>CSV file to import: </label><input type='file' name='{$this->field}'/><br/><br/>
          <input type='submit' name='import' class='button' value='Import File'/>
          <input type='submit' name='preview' class='button' value='Preview Import'/>
          </form>"; 
     }
     
     function uploadDataImportFile()
     {
          global $config;
          
          $file = $_FILES[$this->field]["tmp_name"];
          
          if(!$file)
          {
               return;
          }
          
          $fullpath = $config["uploadbase"] . DIRECTORY_SEPARATOR . basename($file);
     
          if (file_exists($fullpath))
          {
               unlink($fullpath);
          }
     
          trace("Uploading $file to $fullpath", 3);
     
          move_uploaded_file($file, $fullpath);
          chmod($fullpath, 0755);
     
          $this->filepath = $fullpath;
     }    
 
     function drawButtons()
     {
          $buttons = array();
          
          foreach($this->buttons as $button)
          {
               $url = ($button['isScript']) ? $button['url'] : "go('{$button['url']}');";
               
               if ($button['confirm'])
               {
                    $link = "if (confirm('".jsSafe($button['confirm'])."')) $url; return false;";
               }
               else
               {
                    $link = "$url; return false;";
               }
               
               if(preg_match("/import=1/", $url) && !count($this->objs))
               {
                    continue;
               }
               $buttons[] = "<input type='button' class='{$this->buttonCSS}' onclick=\"$link\" value=\"{$button['text']}\"/>";
          }
          
          if($this->preview && $this->table && count($this->table->items))
          {
               array_unshift($buttons, "<input type='submit' name='import' class='button' value='Import File'/>\n");
          }
 
          echo "<div class='button_row'>" . implode("&nbsp;&nbsp;", $buttons) . "</div>";
     }
               
     function openFile()
     {
          $filepath = $this->getFilePath();
          $fp = fopen($filepath, 'r');
          
          if (fgetcsv($fp) == FALSE)
          {
               echo "<div class='error'>Cannot open data file {$filepath}.</div>\n";
               return null;
          }
          
          return $fp;
     }
     
     function getFilePath()
     {
          if($this->filepath)
          {
               return $this->filepath;
          }
          else if($_FILES[$this->field]["tmp_name"])
          {
               return $_FILES[$this->field]["tmp_name"];
          }
          else if($_POST[$this->field])
          {
               return $_POST[$this->field];
          }
          
          return null;
     }
     
     function buildPreviewTable()
     {              
          $pObjs = $this->createPreviewData();
 
          $pk = $this->getPrimaryKey();
          $table = new DataListView($pObjs, $this->id);
          $table->column("Row", array($this, formatRowIndex));
          $table->column(prettify($pk), "{{$pk}}");
          
          foreach($this->columns as $column)
          {
               $field = $column->field;
               $table->column($column->label, "{{$field}}");
          }
          
          $table->onStartRow = array($this, previewRowStyle);         
          $table->emptyMessage = "No data to be imported.";
          $table->sortable = false;
          $table->paginate = false;
          $table->filter = false;
          
          return $table;
     }
     
     function previewRowStyle($obj)
     {
          $pk = $this->getPrimaryKey();
          if(!$obj->$pk)
          {
               return "data_import_row_new";
          }
     }
     
     function createPreviewData()
     {
          $filter = new InclusionFilter();
          foreach($this->columns as $column)
          {
               $filter->add($column->field);
          }
 
          $pObjs = array();
          if(count($this->objs))
          {
               foreach($this->objs as $obj)
               {
                    $pObj = clone $obj;
                    $pObj->filter = $filter;
                    foreach($this->columns as $column)
                    {
                         $pObj->filter->add($column->field);
                         $pObj->set($column->field, $this->formatPreviewCell($pObj, $column));
                    }
                    
                    $pObjs[] = $pObj;
               }
          }
          
          return $pObjs;
     }
     
     function formatPreviewCell($obj, $column)
     {
          $old = $this->getSavedObj($obj);
                    
          if(is_callable($column->preview_template))
          {
               return call_user_func($column->preview_template, $obj, $old);
          }
     }
     
     
     function importCell($column, $obj, $value)
     {
          if (is_callable($column->importer) && $column->position > 0)
          {
               return call_user_func($column->importer, $obj, $value);
          }
          else if (is_callable($column->importer) && $column->position == 0)
          {
               return call_user_func($column->importer, $obj);
          }
          
          else $column->import($obj, $value);
     }
     
     function formatRowIndex($obj)
     {
          return $obj->row_number;
     }
}
 
class DataImportColumn extends DataItem
{
          var $fields = array(
          "field"        =>   String,
          "label"        =>   String,
          "position"     =>   Number,
          "update_empty" =>   Boolean,
     );
     
     var $options = array();       
     var $importer;                
     var $template;                
     var $preview_template;        
     var $warnings = array(); 
          
     function __construct($field, $position, $label = "", $options, $importer, $update_empty = true)
     {
          $this->primary_key = "field";
          $this->table = "import_column";
 
          $this->field = $field;
          $this->label = $label;
          $this->position = $position;
          $this->importer = $importer;
          $this->options = $options;
          $this->update_empty = $update_empty;
          
          if($this->options && !$importer)
          {
               $this->importer = array($this, importOption);
          }
          
          if($this->options)
          {
               $this->preview_template = array($this, formatOptionPreview);     
          }
          else
          {
               $this->preview_template = array($this, formatPreview);
          }
          
          $this->template = "{{$field}}";
     }
 
     function formatOptionPreview($obj, $old)
     {
          $field = $this->field;
     
          $value = $this->startFormatPreview($obj, $old, $field);
          
          if(!$value)
          {
               $value .= $this->options[$obj->$field] . " (" . $obj->format($this->template) . ")";
          }
          
          $value .= $this->endFormatPreview($old, $field);
          
          return $value; 
     }
     
     function startFormatPreview($obj, $old, $field)
     {
          $warning = $this->getWarning($obj);
          if($warning)
          {
               $obj->fields[$field] = HTML;
               $value = "<span class='warning'>{$warning}</warning>\n";    
          }
     
          if($this->isChanged($old, $field))
          {
               $obj->fields[$field] = HTML;
               $value .= "<b>";
          }
          
          return $value;
     }
     
     function getWarning($obj)
     {
          if(array_key_exists($obj->row_number, $this->warnings))
          {
               return    $this->warnings[$obj->row_number]; 
          }
          
          return "";
     }
     
     function endFormatPreview($old, $field)
     {
          if($this->isChanged($old, $field))
          {
               $value .= "</b></br><i>" . $old->format($this->template) . "</i>";
          }    
     
          return $value;
     }
     
     function isChanged($old, $field)
     {
          if(!$old) return false;
 
          $filter = $old->getFilter();
          if($filter && !$filter->isExcluded($field))
          {
               return true;
          }
          
          return false;
     }
     
     function formatPreview($obj, $old)
     {
          $field = $this->field;
 
          $value = $this->startFormatPreview($obj, $old, $field);
     
          $value .= $obj->format($this->template);
          
          $value .= $this->endFormatPreview($old, $field);
     
          return $value;
     }
     
     function importOption($obj, $value)
     {
          $options = $this->options;
          if(!count($options)) return;
          $label = $this->label;
          
          $options = array_flip($this->options);
          
          if(array_key_exists($value, $options))
          {
               $obj->$field = $options[$value];
          }
          else
          {
               $this->warning[$obj->row_number] = "{$label} $value not found";
          }
     }
     
     function formatOptions()
     {
          if(!count($this->options))
          {
               return "N/A";
          }
 
          foreach($this->options as $key => $value)
          {
               $out[] = $value;
          }
          $out = implode("<br>", $out);
          
          return "<div class='scrollbox' style='height: 200px; overflow: scroll; border: none'>$out</div>";
     }
     
     function import($obj, $value)
     {
          $field = $this->field;
          $obj->$field = $value;
     }
}