(merged from branches/roa. use "svn log -c <changeset> -g <module-svn-path>" for detailed commit message)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@60211 467b73ca-7a2a-4603-9d3b-597d59a354a9

core/model/ComponentSet.php

@@ -281,6 +281,9 @@ class ComponentSet extends DataObjectSet {
 	
 	/**
 	 * Returns information about this set in HTML format for debugging.
+	 * 
+	 * @deprecated 
+	 * 
 	 * @return string
 	 */
 	function debug() {

core/model/DataObject.php

@@ -1172,20 +1172,29 @@ class DataObject extends ViewableData implements DataObjectInterface {
 	public function scaffoldSearchFields() {
 		$fields = new FieldSet();
 		foreach($this->searchable_fields() as $fieldName => $fieldType) {
-			// @todo Pass localized title
-			$fields->push($this->dbObject($fieldName)->scaffoldSearchField());
+			$field = $this->relObject($fieldName)->scaffoldSearchField();
+			if (strstr($fieldName, '.')) {
+				$field->setName(str_replace('.', '__', $fieldName));
+				$parts = explode('.', $fieldName);
+				//$label = $parts[count($parts)-2] . $parts[count($parts)-1];
+				$field->setTitle($this->toLabel($parts[count($parts)-2]));
+			} else {
+				$field->setTitle($this->toLabel($fieldName));	
 			}
-		/*$extras = $this->invokeWithExtensions('extraSearchFields');
-		if ($extras) {
-			foreach($extras as $result) {
-				foreach($result as $fieldName => $fieldType) {
-					$fields->push(new $fieldType($fieldName));
+			$fields->push($field);
 		}
-			}
-		}*/
 		return $fields;
 	}
 	
+	/**
+	 * CamelCase to sentence case label transform
+	 * 
+	 * @todo move into utility class (String::toLabel)
+	 */
+	function toLabel($string) {
+		return preg_replace("/([a-z]+)([A-Z])/","$1 $2", $string);
+	}
+	
 	/**
 	 * Scaffold a simple edit form for all properties on this dataobject,
 	 * based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}
@@ -1574,6 +1583,40 @@ class DataObject extends ViewableData implements DataObjectInterface {
 		*/
 	}
 	
+	/**
+	 * Traverses to a DBField referenced by a relationship.
+	 * 
+	 * @return DBField
+	 */
+	public function relObject($fieldPath) {
+		$parts = explode('.', $fieldPath);
+		$fieldName = array_pop($parts);
+		$component = $this;
+		foreach($parts as $relation) {
+			if ($rel = $component->has_one($relation)) {
+			 	$component = singleton($rel);
+			} elseif ($rel = $component->has_many($relation)) {
+				$component = singleton($rel);
+			}
+		}
+		return $component->dbObject($fieldName);
+	}
+	
+	/**
+	 * Temporary hack to return an association name, based on class, toget around the mangle
+	 * of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
+	 */	
+	public function getReverseAssociation($className) {
+		if (is_array($this->has_many())) {
+			$has_many = array_flip($this->has_many());
+			if (array_key_exists($className, $has_many)) return $has_many[$className];
+		}
+		if (is_array($this->has_one())) {
+			$has_one = array_flip($this->has_one());
+			if (array_key_exists($className, $has_one)) return $has_one[$className];
+		}
+	}
+	
 	/**
 	 * Build a {@link SQLQuery} object to perform the given query.
 	 *
@@ -1922,6 +1965,14 @@ class DataObject extends ViewableData implements DataObjectInterface {
 		}
 	}
 	
+	/**
+	 * Get the name of the base table for this object
+	 */
+	public function baseTable() {
+		$tableClasses = ClassInfo::dataClassesFor($this->class);
+		return array_shift($tableClasses);
+	}
+
 	//-------------------------------------------------------------------------------------------//
 
 	/**
@@ -2144,7 +2195,7 @@ class DataObject extends ViewableData implements DataObjectInterface {
 		$filters = array();
 		foreach($this->searchable_fields() as $name => $type) {
 			if (is_int($name)) {
-				$filters[$type] = $this->dbObject($type)->defaultSearchFilter();
+				$filters[$type] = $this->relObject($type)->defaultSearchFilter();
 			} else {
 				if (is_array($type)) {
 					 $filter = current($type);
@@ -2153,7 +2204,7 @@ class DataObject extends ViewableData implements DataObjectInterface {
 					if (is_subclass_of($type, 'SearchFilter')) {
 						$filters[$name] = new $type($name);
 					} else {
-						$filters[$name] = $this->dbObject($name)->defaultSearchFilter();
+						$filters[$name] = $this->relObject($name)->defaultSearchFilter();
 					}
 				}
 			}
@@ -2161,6 +2212,20 @@ class DataObject extends ViewableData implements DataObjectInterface {
 		return $filters;
 	}
 	
+	/**
+	 * Replace named fields in a relationship with actual path to data objects.
+	 *
+	 * @param string $path
+	 * @return SearchFilter
+	 */
+	protected function mapRelationshipObjects($path) {
+		$path = explode('.', $path);
+		$fieldName = array_pop($path);
+		foreach($path as $relation) {
+			//
+		}
+	}
+	
     /**
     * @return boolean True if the object is in the database
     */

core/model/SQLQuery.php

@@ -132,6 +132,13 @@ class SQLQuery extends Object {
 		return $this;
 	}
 	
+	/**
+	 * Add a LEFT JOIN criteria to the FROM clause. 
+	 */
+	public function leftJoin($table, $onPredicate) {
+		$this->from[] = "LEFT JOIN $table ON $onPredicate";
+	}
+	
 	/**
 	 * Apply a predicate filter to the where clause.
 	 * 

core/model/fieldtypes/DBField.php

@@ -222,7 +222,7 @@ abstract class DBField extends ViewableData {
 	 * @return SearchFilter
 	 */
 	public function defaultSearchFilter() {
-		return new ExactMatchFilter($this->name);
+		return new PartialMatchFilter($this->name);
 	}
 	
 	/**

search/SearchContext.php

@@ -68,7 +68,6 @@ class SearchContext extends Object {
 	/**
 	 * Returns scaffolded search fields for UI.
 	 *
-	 * @todo is this necessary in the SearchContext? - ModelAdmin could unwrap this and just use DataObject::scaffoldSearchFields
 	 * @return FieldSet
 	 */
 	public function getSearchFields() {
@@ -77,6 +76,36 @@ class SearchContext extends Object {
 		return singleton($this->modelClass)->scaffoldSearchFields();
 	}
 	
+	/**
+	 * @todo fix hack
+	 */
+	protected function applyBaseTableFields() {
+		$classes = ClassInfo::dataClassesFor($this->modelClass);
+		//Debug::dump($classes);
+		//die();
+		$fields = array($classes[0].'.*', $this->modelClass.'.*');
+		//$fields = array_keys($model->db());
+		$fields[] = $classes[0].'.ClassName AS RecordClassName';
+		return $fields;
+	}
+
+	/**
+	 * @todo fix hack
+	 */
+	protected function applyBaseTable() {
+		$classes = ClassInfo::dataClassesFor($this->modelClass);
+		return $classes[0];
+	}
+	
+	/**
+	 * @todo only works for one level deep of inheritance
+	 * @todo fix hack
+	 */
+	protected function applyBaseTableJoin($query) {
+		$classes = ClassInfo::dataClassesFor($this->modelClass);
+		if (count($classes) > 1) $query->leftJoin($classes[1], "{$classes[1]}.ID = {$classes[0]}.ID");
+	}
+	
 	/**
 	 * Returns a SQL object representing the search context for the given
 	 * list of query parameters.
@@ -86,15 +115,34 @@ class SearchContext extends Object {
 	 */
 	public function getQuery($searchParams, $start = false, $limit = false) {
 		$model = singleton($this->modelClass);
-		$fields = array_keys($model->db());
-		$query = new SQLQuery($fields, $this->modelClass);
+		
+		$fields = $this->applyBaseTableFields($model);
+	
+		$query = new SQLQuery($fields);
+		
+		$baseTable = $this->applyBaseTable();
+		$query->from($baseTable);
+		
+		// SRM: This stuff is copied from DataObject, 
+		if($this->modelClass != $baseTable) {
+			$classNames = ClassInfo::subclassesFor($this->modelClass);
+			$query->where[] = "`$baseTable`.ClassName IN ('" . implode("','", $classNames) . "')";
+		}
+		
+
+		$this->applyBaseTableJoin($query);
+		
 		foreach($searchParams as $key => $value) {
+			if ($value != '0') {
+				$key = str_replace('__', '.', $key);
 				$filter = $this->getFilter($key);
 				if ($filter) {
+					$filter->setModel($this->modelClass);
 					$filter->setValue($value);
 					$filter->apply($query);
 				}
 			}
+		}
 		return $query;
 	}
 
@@ -111,16 +159,16 @@ class SearchContext extends Object {
 	public function getResults($searchParams, $start = false, $limit = false) {
 		$searchParams = array_filter($searchParams, array($this,'clearEmptySearchFields'));
 		$query = $this->getQuery($searchParams, $start, $limit);
-		//
+
 		// use if a raw SQL query is needed
-		//$results = new DataObjectSet();
-		//foreach($query->execute() as $row) {
-		//	$className = $row['ClassName'];
-		//	$results->push(new $className($row));
-		//}
-		//return $results;
+		$results = new DataObjectSet();
+		foreach($query->execute() as $row) {
+			$className = $row['RecordClassName'];
+			$results->push(new $className($row));
+		}
+		return $results;
 		//
-		return DataObject::get($this->modelClass, $query->getFilter(), "", "", $limit);
+		//return DataObject::get($this->modelClass, $query->getFilter(), "", "", $limit);
 	}
 
 	/**

search/filters/ExactMatchFilter.php

@@ -16,7 +16,8 @@ class ExactMatchFilter extends SearchFilter {
 	 * @return unknown
 	 */
 	public function apply(SQLQuery $query) {
-		return $query->where("{$this->name} = '{$this->value}'");
+		$query = $this->applyRelation($query);
+		return $query->where("{$this->getName()} = '{$this->value}'");
 	}
 	
 }

search/filters/PartialMatchFilter.php

@@ -8,7 +8,8 @@
 class PartialMatchFilter extends SearchFilter {
 	
 	public function apply(SQLQuery $query) {
-		return $query->where("{$this->name} LIKE '%{$this->value}%'");
+		$query = $this->applyRelation($query);
+		return $query->where("{$this->getName()} LIKE '%{$this->value}%'");
 	}
 	
 }

search/filters/SearchFilter.php

@@ -7,11 +7,13 @@
  */
 abstract class SearchFilter extends Object {
 	
+	protected $model;
 	protected $name;
 	protected $value;
+	protected $relation;
 	
 	function __construct($name, $value = false) {
-		$this->name = $name;
+		$this->addRelation($name);
 		$this->value = $value;
 	}
 	
@@ -19,6 +21,75 @@ abstract class SearchFilter extends Object {
 		$this->value = $value;
 	}
 	
+	public function setModel($className) {
+		$this->model = $className;
+	}
+	
+	/**
+	 * Normalizes the field name to table mapping.
+	 *
+	 */
+	protected function getName() {
+		// SRM: This code finds the table where the field named $this->name lives
+		// Todo: move to somewhere more appropriate, such as DataMapper, the magical class-to-be?
+		$candidateClass = $this->model;
+		while($candidateClass != 'DataObject') {
+			if(singleton($candidateClass)->fieldExists($this->name)) break;
+			$candidateClass = get_parent_class($candidateClass);
+		}
+		if($candidateClass == 'DataObject') user_error("Couldn't find field $this->name in any of $this->model's tables.", E_USER_ERROR);
+		
+		return $candidateClass . "." . $this->name;
+	}
+	
+	protected function addRelation($name) {
+		if (strstr($name, '.')) {
+			$parts = explode('.', $name);
+			$this->name = array_pop($parts);
+			$this->relation = $parts;
+		} else {
+			$this->name = $name;
+		}
+	}
+	
+	/**
+	 * Applies multiple-table inheritance to straight joins on the data objects
+	 *
+	 * @todo Should this be applied in SQLQuery->from instead? !!! 
+	 * 
+	 * @return void
+	 */
+	protected function applyJoin($query, $model, $component) {
+		$query->leftJoin($component, "{$this->model}.ID = $component.{$model->getReverseAssociation($this->model)}ID");
+	}
+	
+	/**
+	 * Traverse the relationship fields, and add the table
+	 * mappings to the query object state.
+	 *
+	 * @todo move join specific crap into SQLQuery
+	 * 
+	 * @param unknown_type $query
+	 * @return unknown
+	 */
+	protected function applyRelation($query) {
+		if (is_array($this->relation)) {
+			$model = singleton($this->model);
+			foreach($this->relation as $rel) {
+				if ($component = $model->has_one($rel)) {
+					$model = singleton($component);
+					$this->applyJoin($query, $model, $component);
+					$this->model = $component;
+				} elseif ($component = $model->has_many($rel)) {
+					$model = singleton($component);
+					$this->applyJoin($query, $model, $component);
+					$this->model = $component;
+				}
+			}
+		}
+		return $query;
+	}
+	
 	/**
 	 * Apply filter criteria to a SQL query.
 	 *

tests/CsvBulkLoaderTest.php

@@ -0,0 +1,172 @@
+<?php
+/**
+ * @package tests
+ */
+class CsvBulkLoaderTest extends SapphireTest {
+	static $fixture_file = 'sapphire/tests/CsvBulkLoaderTest.yml';
+
+	/**
+	 * Test plain import with column auto-detection
+	 */
+	function testLoad() {
+		$loader = new CsvBulkLoader('CsvBulkLoaderTest_Player');
+		$filepath = Director::baseFolder() . '/sapphire/tests/CsvBulkLoaderTest_PlayersWithHeader.csv';
+		$file = fopen($filepath, 'r');
+		$compareCount = $this->getLineCount($file);
+		fgetcsv($file); // pop header row
+		$compareRow = fgetcsv($file);
+		$results = $loader->load($filepath);
+
+		// Test that right amount of columns was imported
+		$this->assertEquals($results->Count(), $compareCount-1, 'Test correct count of imported data');
+		
+		// Test that columns were correctly imported
+		$obj = DataObject::get_by_id('CsvBulkLoaderTest_Player', $results->First()->id);
+		$this->assertEquals($compareRow[0], $obj->FirstName);
+		$this->assertEquals($compareRow[1], $obj->Biography);
+		$date = DBField::create('Date', $compareRow[2])->RAW();
+		$this->assertEquals($date, $obj->Birthday);
+		
+		fclose($file);
+	}
+
+	/**
+	 * Test import with manual column mapping
+	 */
+	function testLoadWithColumnMap() {
+		$loader = new CsvBulkLoader('CsvBulkLoaderTest_Player');
+		$filepath = Director::baseFolder() . '/sapphire/tests/CsvBulkLoaderTest_Players.csv';
+		$file = fopen($filepath, 'r');
+		$compareCount = $this->getLineCount($file);
+		$compareRow = fgetcsv($file);
+		$loader->columnMap = array(
+			'FirstName',
+			'Biography',
+			null, // ignored column
+			'Birthday'
+		);
+		$results = $loader->load($filepath);
+
+		// Test that right amount of columns was imported
+		$this->assertEquals($results->Count(), $compareCount, 'Test correct count of imported data');
+		
+		// Test that columns were correctly imported
+		$obj = DataObject::get_by_id('CsvBulkLoaderTest_Player', $results->First()->id);
+		$this->assertEquals($compareRow[0], $obj->FirstName);
+		$this->assertEquals($compareRow[1], $obj->Biography);
+		$date = DBField::create('Date', $compareRow[3])->RAW();
+		$this->assertEquals($date, $obj->Birthday);
+		
+		fclose($file);
+	}
+
+	/**
+	 * Test import with manual column mapping and custom column names
+	 */
+	function testLoadWithCustomHeaderAndRelation() {
+		$loader = new CsvBulkLoader('CsvBulkLoaderTest_Player');
+		$filepath = Director::baseFolder() . '/sapphire/tests/CsvBulkLoaderTest_PlayersWithCustomHeaderAndRelation.csv';
+		$file = fopen($filepath, 'r');
+		$compareCount = $this->getLineCount($file);
+		fgetcsv($file); // pop header row
+		$compareRow = fgetcsv($file);
+		$loader->columnMap = array(
+			'first name' => 'FirstName',
+			'bio' => 'Biography',
+			'bday' => 'Birthday',
+			'teamtitle' => 'Team.Title', // test existing relation
+			'teamsize' => 'Team.TeamSize', // test existing relation
+			'salary' => 'Contract.Amount' // test relation creation
+		);
+		$loader->hasHeaderRow = true;
+		$loader->relationCallbacks = array(
+			'Team.Title' => array(
+				'relationname' => 'Team',
+				'callback' => 'getTeamByTitle'
+			),
+			// contract should be automatically discovered
+		);
+		$results = $loader->load($filepath);
+		
+		// Test that right amount of columns was imported
+		$this->assertEquals($results->Count(), $compareCount-1, 'Test correct count of imported data');
+		
+		// Test of augumenting existing relation (created by fixture)
+		$testTeam = DataObject::get_one('CsvBulkLoaderTest_Team', null, null, 'Created DESC');
+		$this->assertEquals('20', $testTeam->TeamSize, 'Augumenting existing has_one relation works');
+		
+		// Test of creating relation
+		$testContract = DataObject::get_one('CsvBulkLoaderTest_PlayerContract');
+		$testPlayer = DataObject::get_by_id('CsvBulkLoaderTest_Player', $results->First()->id);
+		$this->assertEquals($testPlayer->ContractID, $testContract->ID, 'Creating new has_one relation works');
+		
+		// Test nested setting of relation properties
+		$contractAmount = DBField::create('Currency', $compareRow[5])->RAW();
+		$testPlayer = DataObject::get_by_id('CsvBulkLoaderTest_Player', $results->First()->id);
+		$this->assertEquals($testPlayer->Contract()->Amount, $contractAmount, 'Setting nested values in a relation works');
+		
+		// Test that columns were correctly imported
+		$obj = DataObject::get_by_id('CsvBulkLoaderTest_Player', $results->First()->id);
+		
+		fclose($file);
+	}
+	
+	protected function getLineCount(&$file) {
+		$i = 0;
+		while(fgets($file) !== false) $i++;
+		rewind($file);
+		return $i;
+	}
+	
+}
+
+class CsvBulkLoaderTest_Team extends DataObject implements TestOnly {
+	
+	static $db = array(
+		'Title' => 'Varchar(255)',
+		'TeamSize' => 'Int',
+	);	
+	
+	static $has_many = array(
+		'Players' => 'CsvBulkLoaderTest_Player',
+	);
+	
+}
+
+class CsvBulkLoaderTest_Player extends DataObject implements TestOnly {
+	
+	static $db = array(
+		'FirstName' => 'Varchar(255)',
+		'Biography' => 'HTMLText',
+		'Birthday' => 'Date',
+	);
+	
+	static $has_one = array(
+		'Team' => 'CsvBulkLoaderTest_Team',
+		'Contract' => 'CsvBulkLoaderTest_PlayerContract'
+	);
+	
+	public function getTeamByTitle($title) {
+		$SQL_title = Convert::raw2sql($title);
+		return DataObject::get_one('CsvBulkLoaderTest_Team', "Title = '{$SQL_title}'");
+	}
+	
+	/**
+	 * Custom setter for "Birthday" property when passed/imported
+	 * in different format.
+	 *
+	 * @param string $val
+	 * @param array $record
+	 */
+	public function setUSBirthday($val, $record) {
+		$this->Birthday = preg_replace('/^([0-9]{1,2})\/([0-9]{1,2})\/([0-90-9]{2,4})/', '\\3-\\1-\\2', $val);
+	}
+}
+
+class CsvBulkLoaderTest_PlayerContract extends DataObject implements TestOnly {
+	static $db = array(
+		'Amount' => 'Currency',
+	);
+}
+
+?>

tests/CsvBulkLoaderTest.yml

@@ -0,0 +1,3 @@
+CsvBulkLoaderTest_Team:
+   team1:
+      Title: My Team

tests/CsvBulkLoaderTest_Players.csv

@@ -0,0 +1,4 @@
+"John","He's a good guy","ignored","31/01/1988"
+"Jane","She is awesome.\nSo awesome that she gets multiple rows and \"escaped\" strings in her biography","ignored","31/01/1982"
+"Jamie","Pretty old\, with an escaped comma","ignored","31/01/1882"
+"Järg","Unicode FTW","ignored","31/06/1982"

tests/CsvBulkLoaderTest_PlayersWithCustomHeaderAndRelation.csv

@@ -0,0 +1,2 @@
+"first name","bio","bday","teamtitle","teamsize","salary"
+"John","He's a good guy","1988-01-31","My Team","20","20000"

tests/CsvBulkLoaderTest_PlayersWithHeader.csv

@@ -0,0 +1,5 @@
+"FirstName","Biography","Birthday"
+"John","He's a good guy","31/01/1988"
+"Jane","She is awesome.\nSo awesome that she gets multiple rows and \"escaped\" strings in her biography","31/01/1982"
+"Jamie","Pretty old\, with an escaped comma","31/01/1882"
+"Järg","Unicode FTW","31/06/1982"

tests/SQLQueryTest.php

@@ -14,7 +14,7 @@ class SQLQueryTest extends SapphireTest {
 		$query->from[] = "MyTable";
 		$this->assertEquals("SELECT * FROM MyTable", $query->sql());
 		$query->from[] = "MyJoin";
-		$this->assertEquals("SELECT * FROM MyTable, MyJoin", $query->sql());
+		$this->assertEquals("SELECT * FROM MyTable MyJoin", $query->sql());
 	}
 	
 	function testSelectFromUserSpecifiedFields() {

tests/SearchContextTest.php

@@ -74,9 +74,22 @@ class SearchContextTest extends SapphireTest {
 		$project = singleton('SearchContextTest_Project');
 		$context = $project->getDefaultSearchContext();
 		
-		$query = array("Name"=>"Blog Website");
+		$params = array("Name"=>"Blog Website", "Actions__SolutionArea"=>"technical");
 		
-		$results = $context->getQuery($query);
+		$results = $context->getResults($params);
+		
+		$this->assertEquals(1, $results->Count());
+		
+		Debug::dump(DB::query("select * from SearchContextTest_Deadline")->next());
+		
+		$project = $results->First();
+		
+		$this->assertType('SearchContextTest_Project', $project);
+		$this->assertEquals("Blog Website", $project->Name);
+		$this->assertEquals(2, $project->Actions()->Count());
+		$this->assertEquals("Get RSS feeds working", $project->Actions()->First()->Description);
+		Debug::dump($project->Deadline()->CompletionDate);
+		//$this->assertEquals()
 	}
 	
 	function testCanGenerateQueryUsingAllFilterTypes() {
@@ -157,7 +170,8 @@ class SearchContextTest_Project extends DataObject implements TestOnly {
 	
 	static $searchable_fields = array(
 		"Name" => "PartialMatchFilter",
-		"Actions.SolutionArea" => "ExactMatchFilter"
+		"Actions.SolutionArea" => "ExactMatchFilter",
+		"Actions.Description" => "PartialMatchFilter"
 	);
 	
 }

tests/SearchContextTest.yml

@@ -25,32 +25,36 @@ SearchContextTest_Person:
         HairColor: black
         EyeColor: green
 
+SearchContextTest_Action:
+    action1:
+        Description: Get search context working
+        SolutionArea: technical
+    action2:
+        Description: Get relationship editor working
+        SolutionArea: design
+    action3:
+        Description: Get RSS feeds working
+        SolutionArea: technical
+    action4:
+        Description: New logotype
+        SolutionArea: design
+
+
 SearchContextTest_Deadline:
     deadline1:
         CompletionDate: 2008-05-29 09:00:00
     deadline2:
-        CompletionDate: 2008-05-29 09:00:00
-
-SearchContextTest_Action:
-    action1:
-        Description: Get search context working
-        SolutionArea: backend
-    action2:
-        Description: Get relationship editor working
-        SolutionArea: frontend
-    action3:
-        Description: Get RSS feeds working
-        SolutionArea: technical
+        CompletionDate: 2008-05-20 09:00:00
 
 SearchContextTest_Project:
     project1:
         Name: CRM Application
-        Deadline: =>SearchContextTest_Deadline.deadline1
+        DeadlineID: =>SearchContextTest_Deadline.deadline1
         Actions: =>SearchContextTest_Action.action1,=>SearchContextTest_Action.action2
     project2:
         Name: Blog Website
-        Deadline: =>SearchContextTest_Deadline.deadline2
-        Actions: =>SearchContextTest_Action.action3
+        DeadlineID: =>SearchContextTest_Deadline.deadline2
+        Actions: =>SearchContextTest_Action.action3,=>SearchContextTest_Action.action4
 
 SearchContextTest_AllFilterTypes:
     filter1:

tools/BulkLoader.php

@@ -0,0 +1,154 @@
+<?php
+/**
+ * A base for bulk loaders of content into the SilverStripe database.
+ * Bulk loaders give SilverStripe authors the ability to do large-scale uploads into their Sapphire databases.
+ * 
+ * You can configure column-handling, 
+ * 
+ * @todo Allow updating of existing records based on user-specified unique criteria/callbacks (e.g. database ID)
+ * @todo Add support for adding/editing has_many relations.
+ * @todo Add support for deep chaining of relation properties (e.g. Player.Team.Stats.GoalCount)
+ * 
+ * @see http://rfc.net/rfc4180.html
+ * @package cms
+ * @subpackage bulkloading
+ * @author Ingo Schommer, Silverstripe Ltd. (<firstname>@silverstripe.com)
+ */
+abstract class BulkLoader extends ViewableData {
+	
+	/**
+	 * Each row in the imported dataset should map to one instance
+	 * of this class (with optional property translation
+	 * through {@self::$columnMaps}.
+	 *
+	 * @var string
+	 */
+	public $objectClass;
+	
+	/**
+	 * Override this on subclasses to give the specific functions names.
+	 * 
+	 * @var string
+	 */
+	public static $title;
+
+	/**
+	 * Map columns to DataObject-properties.
+	 * If not specified, we assume the first row
+	 * in the file contains the column headers.
+	 * The order of your array should match the column order.
+	 * 
+	 * The column count should match the count of array elements,
+	 * fill with NULL values if you want to skip certain columns.
+	 * 
+	 * Supports one-level chaining of has_one relations and properties with dot notation
+	 * (e.g. Team.Title). The first part has to match a has_one relation name
+	 * (not necessarily the classname of the used relation).
+	 * 
+	 * <code>
+	 * <?php
+	 * 	// simple example
+	 *  array(
+	 *  	'Title',
+	 * 		'Birthday'
+	 * 	)
+	 * 
+	 * // complex example
+	 * 	array(
+	 * 		'first name' => 'FirstName', // custom column name
+	 * 		null, // ignored column
+	 * 		'RegionID', // direct has_one/has_many ID setting
+	 * 		'OrganisationTitle', // create has_one relation to existing record using $relationCallbacks
+	 * 		'street' => 'Organisation.StreetName', // match an existing has_one or create one and write property.
+	 * 	);
+	 * ?>
+	 * </code>
+	 *
+	 * @var array
+	 */
+	public $columnMap;
+	
+	/**
+	 * Find a has_one relation based on a specific column value.
+	 * 
+	 * <code>
+	 * <?php
+	 * array(
+	 * 		'OrganisationTitle' => array(
+	 * 			'relationname' => 'Organisation', // relation accessor name
+	 * 			'callback' => 'getOrganisationByTitle',
+	 *		);
+	 * );
+	 * ?>
+	 * </code>
+	 *
+	 * @var array
+	 */
+	public $relationCallbacks;
+	
+	function __construct($objectClass) {
+		$this->objectClass = $objectClass;
+	}
+	
+	/*
+	 * Load the given file via {@link self::processAll()} and {@link self::processRecord()}.
+	 *  
+	 * @return array See {@link self::processAll()}
+	 */
+	public function load($filepath) {
+		return $this->processAll($filepath);
+	}
+	
+	/**
+	 * Preview a file import (don't write anything to the database).
+	 * Useful to analyze the input and give the users a chance to influence
+	 * it through a UI.
+	 *
+	 * @param string $filepath Absolute path to the file we're importing
+	 * @return array See {@link self::processAll()}
+	 */
+	public function preview($filepath) {
+		return $this->processAll($filepath, true);
+	}
+	
+	/**
+	 * Process every record in the file
+	 * 
+	 * @param string $filepath Absolute path to the file we're importing (with UTF8 content)
+	 * @param boolean $preview If true, we'll just output a summary of changes but not actually do anything
+	 * @return array Information about the import process, with each row matching a created or updated DataObject.
+	 * 	Array structure:
+	 *  - 'id': Database id of the created or updated record
+	 *  - 'action': Performed action ('create', 'update') 
+	 *  - 'message': free-text string that can optionally provide some more information about what changes have
+	 */
+	abstract protected function processAll($filepath, $preview = false);
+	
+
+	/**
+	 * Process a single record from the file.
+	 * 
+	 * @param array $record An map of the data, keyed by the header field defined in {@link self::$columnMap}
+	 * @param boolean $preview
+	 * @return ArrayData @see self::processAll()
+	 */
+	abstract protected function processRecord($record, $preview = false);
+	
+	/**
+	 * Return a FieldSet containing all the options for this form; this
+	 * doesn't include the actual upload field itself
+	 */
+	public function getOptionFields() {}
+	
+	/**
+	 * Return a human-readable name for this object.
+	 * It defaults to the class name can be overridden by setting the static variable $title
+	 * 
+	 * @return string
+	 */
+	public function Title() {
+		return ($title = $this->stat('title')) ? $title : $this->class;
+	}
+	
+}
+?>

tools/CsvBulkLoader.php

@@ -0,0 +1,139 @@
+<?php
+/**
+ * Uses the fgetcsv() function to process CSV input.
+ * The input is expected to be UTF8.
+ * 
+ * @see http://rfc.net/rfc4180.html
+ * @package cms
+ * @subpackage bulkloading
+ * @author Ingo Schommer, Silverstripe Ltd. (<firstname>@silverstripe.com)
+ */
+class CsvBulkLoader extends BulkLoader {
+	
+	/**
+	 * Delimiter character (Default: comma).
+	 *
+	 * @var string
+	 */
+	public $delimiter = ',';
+	
+	/**
+	 * Enclosure character (Default: doublequote)
+	 *
+	 * @var string
+	 */
+	public $enclosure = '"';
+	
+	/**
+	 * Identifies if the loaded file has a header row.
+	 * If a {@link self::$columnMap} is passed, we assume
+	 * the file has no headerrow, unless explicitly noted.
+	 *
+	 * @var boolean
+	 */
+	public $hasHeaderRow = false;
+	
+	protected function processAll($filepath, $preview = false) {
+		$file = fopen($filepath, 'r');
+		if(!$file) return false;
+		
+		$return = new DataObjectSet();
+		
+		// assuming that first row is column naming if no columnmap is passed
+		if($this->hasHeaderRow && $this->columnMap) {
+			$columnRow = fgetcsv($file, 0, $this->delimiter, $this->enclosure);
+			$columnMap = $this->columnMap;
+		} elseif($this->columnMap) {
+			$columnMap = $this->columnMap;
+		} else {
+			$columnRow = fgetcsv($file, 0, $this->delimiter, $this->enclosure);
+			$columnMap = array_combine($columnRow, $columnRow);
+		}
+		
+		while (($row = fgetcsv($file, 0, $this->delimiter, $this->enclosure)) !== FALSE) {
+			$indexedRow = array_combine(array_values($columnMap), array_values($row));
+			$return->push($this->processRecord($indexedRow));
+		}
+		
+		fclose($file);
+		
+		return $return;
+	}
+	
+
+	protected function processRecord($record, $preview = false) {
+		$class = $this->objectClass;
+		$obj = new $class();
+		
+		// first run: find/create any relations and store them on the object
+		// we can't combine runs, as other columns might rely on the relation being present
+		$relations = array();
+		foreach($record as $key => $val) {
+			if(isset($this->relationCallbacks[$key])) {
+				// trigger custom search method for finding a relation based on the given value
+				// and write it back to the relation (or create a new object)
+				$relationName = $this->relationCallbacks[$key]['relationname'];
+				$relationObj = $obj->{$this->relationCallbacks[$key]['callback']}($val, $record);
+				if(!$relationObj || !$relationObj->exists()) {
+					$relationClass = $obj->has_one($relationName);
+					$relationObj = new $relationClass();
+					$relationObj->write();
+				}
+				$obj->setComponent($relationName, $relationObj);
+				$obj->{"{$relationName}ID"} = $relationObj->ID;
+			} elseif(strpos($key, '.') !== false) {
+				// we have a relation column with dot notation
+				list($relationName,$columnName) = split('\.', $key);
+				$relationObj = $obj->getComponent($relationName); // always gives us an component (either empty or existing)
+				$obj->setComponent($relationName, $relationObj);
+				$relationObj->write();
+				$obj->{"{$relationName}ID"} = $relationObj->ID;
+			}
+			$obj->flushCache(); // avoid relation caching confusion
+		}
+		$id = ($preview) ? 0 : $obj->write();
+
+		
+		// second run: save data
+		foreach($record as $key => $val) {
+			if($obj->hasMethod("import{$key}")) {
+				$obj->{"import{$key}"}($val, $record);
+			} elseif(strpos($key, '.') !== false) {
+				// we have a relation column
+				list($relationName,$columnName) = split('\.', $key);
+				$relationObj = $obj->getComponent($relationName);
+				$relationObj->{$columnName} = $val;
+				$relationObj->write();
+				$obj->flushCache(); // avoid relation caching confusion
+			} elseif($obj->hasField($key)) {
+				// plain old value setter
+				$obj->{$key} = $val;
+			}
+		}
+		$id = ($preview) ? 0 : $obj->write();
+		$action = 'create';
+		$message = '';
+		
+		// memory usage
+		unset($obj);
+		
+		return new ArrayData(array(
+			'id' => $id,
+			'action' => $action,
+			'message' => $message
+		));
+	}
+	
+	
+	/**
+	 * Determine wether any loaded files should be parsed
+	 * with a header-row (otherwise we rely on {@link self::$columnMap}.
+	 *
+	 * @return boolean
+	 */
+	public function hasHeaderRow() {
+		return ($this->hasHeaderRow || isset($this->columnMap));
+	}
+	
+}
+?>