';
+ echo "Running...\n";
+ }
+
connectDB(REASON_DB);
+ mysql_set_charset('utf8');
$this->disable_output_buffering();
- echo "Running\n";
- //$this->import_course_blocks();
- //return;
-
- //$this->delete_all_course_entities();
-
- //foreach ($this->get_section_org_ids() as $org_id)
- //{
- if ($raw_data = $this->get_course_template_data())
+ if (empty($org_ids) && !$org_ids = $this->get_template_org_ids()) $org_ids = array(null);
+ foreach ($org_ids as $org_id)
+ {
+ if ($raw_data = $this->get_course_template_data($org_id))
{
if ($mapped_data = $this->map_course_template_data($raw_data))
{
- $this->build_course_template_entities($mapped_data, $this->get_existing_template_ids());
+ $this->build_course_template_entities($mapped_data, $this->get_existing_template_ids($org_id), $this->delete_missing_templates);
+ unset($raw_data);
+ unset($mapped_data);
}
else
{
@@ -55,18 +184,22 @@ public function run()
}
else
{
- $this->errors[] = 'No course template data received for '.$org_id.'.';
+ if ($this->verbosity == 2) $this->errors[] = 'No course template data received for '.$org_id.'.';
}
- //}
- //return;
- foreach ($this->get_section_org_ids() as $org_id)
- {
+ if ($this->errors) echo join("\n", $this->errors)."\n";
+ $this->errors = array();
+ }
+ if (empty($org_ids) && !$org_ids = $this->get_section_org_ids()) $org_ids = array(null);
+ foreach ($org_ids as $org_id)
+ {
if ($raw_data = $this->get_course_section_data($org_id))
{
if ($mapped_data = $this->map_course_section_data($raw_data))
{
- $this->build_course_section_entities($mapped_data);
+ $this->build_course_section_entities($mapped_data, $this->get_existing_section_ids($org_id), $this->delete_missing_sections);
+ unset($raw_data);
+ unset($mapped_data);
}
else
{
@@ -75,14 +208,105 @@ public function run()
}
else
{
- $this->errors[] = 'No course section data received for '.$org_id.'.';
+ if ($this->verbosity == 2) $this->errors[] = 'No course section data received for '.$org_id.'.';
}
+ if ($this->errors) echo join("\n", $this->errors)."\n";
+ $this->errors = array();
}
- echo join("\n", $this->errors);
- echo "Import Complete.\n";
+ if ($this->errors) echo join("\n", $this->errors)."\n";
+ if ($this->verbosity == 2) echo "Import Complete.\n";
+ }
+
+ /**
+ * Retrieves a list of valid 'org_id' values (your department/subject codes).
+ * Typically this is the same for templates and sections, but you can define them
+ * separately if necessary.
+ */
+ protected function get_template_org_ids()
+ {
+ return $this->get_section_org_ids();
}
+ /**
+ * Retrieves a list of valid 'org_id' values (your department/subject codes).
+ * Typically this is the same for templates and sections, but you can define them
+ * separately if necessary.
+ */
+ protected function get_section_org_ids()
+ {
+ return array();
+ }
+
+ /**
+ * This method does all the work of retrieving your raw course template data from
+ * wherever it lives: via a query into your ERP, a query to a local data mirror,
+ * retrieving data from flat files, etc. The result should be an array with one row
+ * per course. It doesn't matter how that data is structured -- it will be massaged
+ * into shape by the mapping step.
+ *
+ * You should allow for passing an optional org_id value (a department/subject code)
+ * to retrieve only a subset of data.
+ *
+ * @param mixed $org_id
+ */
+ protected function get_course_template_data($org_id = null)
+ {
+ return array();
+ }
+
+ /**
+ * This is a set of rules for excluding course templates from being imported. The method is
+ * passed a single row of data produced by get_course_template_data(), and based on the values
+ * in that row you can pass true or false to indicate whether the row should be discarded.
+ * This is helpful if you need to exclude courses based on values that are difficult to
+ * restrict in your initial query.
+ *
+ * @param type $row
+ * @return boolean
+ */
+ protected function should_exclude_course_template($row)
+ {
+ return false;
+ }
+
+ /**
+ * This method does all the work of retrieving your raw course section data from
+ * wherever it lives: via a query into your ERP, a query to a local data mirror,
+ * retrieving data from flat files, etc. The result should be an array with one row
+ * per section. It doesn't matter how that data is structured -- it will be massaged
+ * into shape by the mapping step.
+ *
+ * You should allow for passing an optional org_id value (a department/subject code)
+ * to retrieve only a subset of data.
+ *
+ * @param mixed $org_id
+ */
+ protected function get_course_section_data($org_id = null)
+ {
+ return array();
+ }
+
+ /**
+ * This is a set of rules for excluding course templates from being imported. The method is
+ * passed a single row of data produced by get_course_template_data(), and based on the values
+ * in that row you can pass true or false to indicate whether the row should be discarded.
+ * This is helpful if you need to exclude courses based on values that are difficult to
+ * restrict in your initial query.
+ *
+ * @param type $row
+ * @return boolean
+ */
+ protected function should_exclude_course_section($row)
+ {
+ return false;
+ }
+
+ /**
+ * Given the 'sourced_id' value of a course template, return the corresponding entity.
+ *
+ * @param mixed ID
+ */
protected function get_section_parent($parent_template_id)
{
$es = new entity_selector();
@@ -95,14 +319,15 @@ protected function get_section_parent($parent_template_id)
return false;
}
+ /**
+ * Given a course section entity, create a relationship with its parent course template.
+ *
+ * @param object
+ */
protected function link_section_to_parent($section)
{
- //echo round(memory_get_usage()/1024,2)."K at point A\n";
-
if ($template = $this->get_section_parent($section->get_value('parent_template_id')))
{
- // echo round(memory_get_usage()/1024,2)."K at point B\n";
-
if (!$parents = $section->get_right_relationship('course_template_to_course_section'))
{
return create_relationship( $template->id(), $section->id(), relationship_id_of('course_template_to_course_section'),false,false);
@@ -110,7 +335,7 @@ protected function link_section_to_parent($section)
else if (is_array($parents))
{
$current_template = reset($parents);
- // echo round(memory_get_usage()/1024,2)."K at point C\n";
+
// verify that we have the correct parent, and fix if not.
if ($current_template->get_value('sourced_id') == $template->get_value('sourced_id'))
{
@@ -118,142 +343,310 @@ protected function link_section_to_parent($section)
}
else
{
- //$this->errors[] = 'Incorrect template attached to '.$section->get_value('name');
- echo 'Incorrect template attached to '.$section->get_value('name');
+ $this->errors[] = 'Incorrect template attached to '.$section->get_value('name');
}
}
else
{
- //$this->errors[] = 'Non-array '.$parents.' returned from get_right_relationship';
- echo 'Non-array '.$parents.' returned from get_right_relationship';
+ $this->errors[] = 'Non-array '.$parents.' returned from get_right_relationship';
}
}
else
{
- //$this->errors[] = 'No template found for '.$section->get_value('name');
- echo 'No template found for '.$section->get_value('name');
+ $this->errors[] = 'No template found for '.$section->get_value('name');
return false;
}
}
- protected function build_course_template_entities($data, $existing = array())
+ /**
+ * Given the massaged array of data produced by map_course_template_data(), build or
+ * update the corresponding entities. You can optionally pass an array of all the
+ * existing course template entity ids, to generate a report of entities that have
+ * dropped from the source feed.
+ *
+ * @param array Course data
+ * @param array IDs of existing course template entities.
+ * @param boolean Whether to delete entities dropped from data feed (not recommended)
+ *
+ * @todo Have deletion of templates pay attention to the time range selected
+ */
+ protected function build_course_template_entities($data, $existing = array(), $delete = false)
{
- echo "Building entities\n";
+ if ($this->verbosity == 2) echo "Building entities\n";
+ $creator = get_user_id($this->entity_creator);
foreach ($data as $key => $row)
{
- $name = sprintf('%s %s %s', $row['org_id'], $row['course_number'], $row['title']);
- //echo 'Adding '.$name ."\n"; continue;
+ $name = $this->build_course_template_entity_name($row);
$es = new entity_selector();
+ $factory = new CourseTemplateEntityFactory();
+ $es->set_entity_factory($factory);
$es->add_type(id_of('course_template_type'));
$es->add_relation('sourced_id = "'.$row['sourced_id'].'"');
if ($result = $es->run_one())
{
$course = reset($result);
- // Find all the values that correspond to the data we're importing
- $values = array_intersect_key($course->get_values(), $row);
- if ($values != $row)
- {
- echo 'Updating '.$name ."\n";
- reason_update_entity( $course->id(), get_user_id('causal_agent'), $row, false);
- }
-
+ $this->update_course_template($row, $course);
$key = array_search($course->id(), $existing);
if ($key !== false) unset($existing[$key]);
}
else
{
- echo 'Adding '.$name ."\n";
- reason_create_entity( id_of($this->current_site), id_of('course_template_type'), get_user_id('causal_agent'), $name, $row);
+ if ($this->verbosity > 0) $this->errors[] = 'Adding '.$name;
+ $row['new'] = 0;
+ $this->process_new_course_template($row);
+ if (!$this->test_mode)
+ reason_create_entity( id_of($this->courses_site), id_of('course_template_type'), $creator, $name, $row);
}
}
if (count($existing))
{
- $user = get_user_id('causal_agent');
foreach ($existing as $id)
{
- $course = new CourseTemplateType($id);
- echo 'Would Delete: '.$course->get_value('name')."\n";
- //reason_expunge_entity($id, $user);
+ $course = new $GLOBALS['course_template_class']($id);
+ if ($this->verbosity == 2) $this->errors[] = 'No longer in feed: '.$course->get_value('name');
+ if ($delete && !$this->test_mode) reason_expunge_entity($id, $creator);
}
}
+ }
+
+ /**
+ * Update an existing course template entity with new values. Extend this if you need to perform
+ * additional actions on the data before or after an update action.
+ *
+ * @param array $data Values to apply
+ * @param object $entity Existing entity object
+ */
+ protected function update_course_template($data, $entity)
+ {
+ if ($this->verbosity > 0) $name = $this->build_course_template_entity_name($data);
+
+ // Remove any fields which are managed on the Reason side
+ foreach ($this->template_data_reason_managed as $key)
+ {
+ if (isset($data[$key])) unset($data[$key]);
+ }
+
+ $current_values = $entity->get_values();
+
+ // Extract the external data cache so that we can compare it separately with the current
+ // external data (the timestamp needs to be removed for an accurate comparison).
+ $current_cache = '';
+ if (isset($current_values['cache']))
+ {
+ $current_cache = json_decode($current_values['cache'], true);
+ if (empty($current_cache)) $current_cache = array();
+ unset($current_values['cache']);
+ if (isset($current_cache['timestamp'])) unset($current_cache['timestamp']);
+ }
+
+ $external_data = $entity->fetch_external_data(true, false);
+
+ // Find all the values that correspond to the data we're importing
+ $values = array_intersect_assoc($current_values, $data);
+ if ($values != $data || $external_data != $current_cache)
+ {
+ $external_data['timestamp'] = time();
+ $data['cache'] = json_encode($external_data);
+ if ($this->verbosity > 0) $this->errors[] = 'Updating '.$name;
+ if (!$this->test_mode)
+ reason_update_entity( $entity->id(), get_user_id($this->entity_creator), $data, false);
+ }
+ else
+ {
+ if ($this->verbosity == 2) $this->errors[] = 'Unchanged: '.$name;
+ }
+ }
+
+ /**
+ * This method provides a hook that is run before a new course template is added to Reason.
+ * If you want to modify values based on existing entities, or do something else when you know
+ * that a template is new, you can do that here. The data row representing the template is
+ * passed and updated by reference.
+ *
+ * @param type $row
+ */
+ protected function process_new_course_template(&$row)
+ {
}
+
+ /**
+ * Construct the template entity name (only visible in the Reason admin). You can modify this
+ * method if you want your names constructed differently.
+ *
+ * @param array data row
+ * @return string
+ */
+ protected function build_course_template_entity_name($row)
+ {
+ return sprintf('%s %s %s', $row['org_id'], $row['course_number'], $row['title']);
+ }
- protected function build_course_section_entities($data)
+ /**
+ * Given the data assembled by map_course_section_data(), look to see if there's a matching
+ * entity. If there is, update it if any values have changed. If no entity exists,
+ * create one and link it to its parent course template entity.
+ *
+ * @param array data row
+ * @return string
+ *
+ * @todo Have deletion of sections pay attention to the time range selected
+ */
+ protected function build_course_section_entities($data, $existing = array(), $delete = false)
{
- echo "Building section entities\n";
+ if ($this->verbosity == 2) echo "Building section entities\n";
+ $creator = get_user_id($this->entity_creator);
foreach ($data as $key => $row)
{
- //echo round(memory_get_usage()/1024,2)."K at point E\n";
$es = new entity_selector();
$es->add_type(id_of('course_section_type'));
- $name = sprintf('%s %s %s', $row['course_number'], $row['academic_session'], $row['title'] );
+ $factory = new CourseSectionEntityFactory();
+ $es->set_entity_factory($factory);
+ $name = $this->build_course_section_entity_name($row);
$es->relations = array();
$es->add_relation('sourced_id = "'.$row['sourced_id'].'"');
if ($result = $es->run_one())
{
$section = reset($result);
- // Find all the values that correspond to the data we're importing
- $values = array_intersect_key($section->get_values(), $row);
- if ($values != $row)
- {
- echo 'Updating: '.$name ."\n";
- reason_update_entity( $section->id(), get_user_id('causal_agent'), $row, false);
- }
- else
- {
- echo 'Unchanged: '.$name ."\n";
- }
+ $this->update_course_section($row, $section);
+ $key = array_search($section->id(), $existing);
+ if ($key !== false) unset($existing[$key]);
}
else
{
if ($this->get_section_parent($row['parent_template_id']))
{
- echo 'Adding: '.$name ."\n";
- $id = reason_create_entity( id_of($this->current_site), id_of('course_section_type'), get_user_id('causal_agent'), $name, $row);
- $section = new entity($id);
+ if ($this->verbosity > 0) $this->errors[] = 'Adding: '.$name;
+ $row['new'] = 0;
+ $this->process_new_course_section($row);
+ if (!$this->test_mode)
+ {
+ $id = reason_create_entity( id_of($this->courses_site), id_of('course_section_type'), $creator, $name, $row);
+ $section = new entity($id);
+ }
}
else
{
- echo 'No course template found; skipping '.$name ."\n";
+ if ($this->verbosity == 2) $this->errors[] = 'No course template found; skipping '.$name;
continue;
}
}
if (!empty($section))
$this->link_section_to_parent($section);
- //echo round(memory_get_usage()/1024,2)."K at point D\n";
}
+
+ if (count($existing))
+ {
+ foreach ($existing as $id)
+ {
+ $course = new $GLOBALS['course_section_class']($id);
+ if ($this->verbosity == 2) $this->errors[] = 'No longer in feed: '.$course->get_value('course_number').': '.$course->get_value('name');
+ if ($delete && !$this->test_mode) reason_expunge_entity($id, $creator);
+ }
+ }
+
}
+ /**
+ * Update an existing course section entity with new values. Extend this if you need to perform
+ * additional actions on the data before or after an update action.
+ *
+ * @param array $data Values to apply
+ * @param object $entity Existing entity object
+ */
+ protected function update_course_section($data, $entity)
+ {
+ if ($this->verbosity > 0) $name = $this->build_course_section_entity_name($data);
+
+ // Remove any fields which are managed on the Reason side
+ foreach ($this->section_data_reason_managed as $key)
+ {
+ if (isset($data[$key])) unset($data[$key]);
+ }
+
+ $current_values = $entity->get_values();
+
+ // Extract the external data cache so that we can compare it separately with the current
+ // external data (the timestamp needs to be removed for an accurate comparison).
+ $current_cache = '';
+ if (isset($current_values['cache']))
+ {
+ $current_cache = json_decode($current_values['cache'], true);
+ if (empty($current_cache)) $current_cache = array();
+ unset($current_values['cache']);
+ if (isset($current_cache['timestamp'])) unset($current_cache['timestamp']);
+ }
+
+ $external_data = $entity->fetch_external_data(true, false);
+
+ // Find all the values that correspond to the data we're importing
+ $values = array_intersect_assoc($current_values, $data);
+ if ($values != $data || $external_data != $current_cache)
+ {
+ $external_data['timestamp'] = time();
+ $data['cache'] = json_encode($external_data);
+ if ($this->verbosity > 0) $this->errors[] = 'Updating: '.$name;
+ if (!$this->test_mode)
+ reason_update_entity( $entity->id(), get_user_id($this->entity_creator), $data, false);
+ }
+ else
+ {
+ if ($this->verbosity == 2) $this->errors[] = 'Unchanged: '.$name;
+ }
+
+ }
+
+ /**
+ * This method provides a hook that is run before a new course template is added to Reason.
+ * If you want to modify values based on existing entities, or do something else when you know
+ * that a template is new, you can do that here. The data row representing the template is
+ * passed and updated by reference.
+ *
+ * @param type $row
+ */
+ protected function process_new_course_section(&$row)
+ {
+
+ }
+
+ /**
+ * Construct the section entity name (only visible in the Reason admin). You can modify this
+ * method if you want your names constructed differently.
+ *
+ * @param array data row
+ * @return string
+ */
+ protected function build_course_section_entity_name($row)
+ {
+ return sprintf('%s %s %s', $row['course_number'], $row['academic_session'], $row['title'] );
+ }
+
+ /**
+ * This method accepts the raw data array generated in get_course_template_data() and
+ * maps it to the Reason course schema based on the rules found in $this->template_data_map.
+ * Rules can specify a one-to-one mapping between a source field and a schema field,
+ * specify a function to be called to perform the mapping, or assign a static value.
+ *
+ * @param array Raw course template data
+ */
protected function map_course_template_data($data)
{
- echo "map_course_template_data\n";
- $map = array(
- 'course_number' => 'SEC_COURSE_NO',
- 'org_id' => 'SEC_SUBJECT',
- 'title' => 'title',
- 'short_description' => null,
- 'long_description' => 'description',
- 'credits' => 'SEC_MAX_CRED',
- 'list_of_prerequisites' => 'prereq',
- 'status' => 'Active',
- 'data_source' => $this->data_source_name,
- 'sourced_id' => 'COURSES_ID',
- );
+ if ($this->verbosity == 2) echo "map_course_template_data\n";
foreach($data as $row)
{
unset($mapped_row);
- foreach ($map as $key => $mapkey)
+ foreach ($this->template_data_map as $key => $mapkey)
{
if ($mapkey)
{
if (method_exists($this, 'template_map_'.$mapkey))
{
$method = 'template_map_'.$mapkey;
- $mapped_row[$key] = $this->$method($row);
+ $value = $this->$method($row);
+ if ($value !== false) $mapped_row[$key] = $value;
}
else if (array_key_exists($mapkey, $row))
{
@@ -279,39 +672,30 @@ protected function map_course_template_data($data)
}
}
+ /**
+ * This method accepts the raw data array generated in get_course_section_data() and
+ * maps it to the Reason course schema based on the rules found in $this->section_data_map.
+ * Rules can specify a one-to-one mapping between a source field and a schema field,
+ * specify a function to be called to perform the mapping, or assign a static value.
+ *
+ * @param array Raw course section data
+ */
protected function map_course_section_data($data)
{
- echo "map_course_template_data\n";
- $map = array(
- 'course_number' => 'SEC_NAME',
- 'org_id' => 'SEC_SUBJECT',
- 'title' => 'title',
- 'short_description' => null,
- 'long_description' => 'description',
- 'credits' => 'credits',
- 'academic_session' => 'SEC_TERM',
- 'timeframe_begin' => 'SEC_START_DATE',
- 'timeframe_end' => 'SEC_END_DATE',
- 'location' => 'location',
- 'meeting' => 'meeting',
- 'notes' => null,
- 'status' => 'Active',
- 'data_source' => $this->data_source_name,
- 'sourced_id' => 'COURSE_SECTIONS_ID',
- 'parent_template_id' => 'SEC_COURSE',
- );
-
+ if ($this->verbosity == 2) echo "map_course_section_data\n";
+
foreach($data as $row)
{
unset($mapped_row);
- foreach ($map as $key => $mapkey)
+ foreach ($this->section_data_map as $key => $mapkey)
{
if ($mapkey)
{
if (method_exists($this, 'section_map_'.$mapkey))
{
$method = 'section_map_'.$mapkey;
- $mapped_row[$key] = $this->$method($row);
+ $value = $this->$method($row);
+ if ($value !== false) $mapped_row[$key] = $value;
}
else if (array_key_exists($mapkey, $row))
{
@@ -339,189 +723,50 @@ protected function map_course_section_data($data)
return false;
}
}
-
- protected function get_course_template_data($org_id = null)
- {
- echo "get_course_template_data $org_id\n";
- $restore_conn = get_current_db_connection_name();
- connectDB('reg_catalog_new');
- mysql_set_charset('utf8');
- $query = 'SELECT * FROM IDM_CRS WHERE CRS_END_DATE IS NULL OR CRS_END_DATE > NOW() ORDER BY CRS_NAME';
- if ($result = mysql_query($query))
- {
- while ($row = mysql_fetch_assoc($result))
- {
- if (strpos($row['CRS_NAME'], 'OCP') === 0) continue;
- if (strpos($row['CRS_NAME'], 'NORW') === 0) continue;
- if (substr($row['CRS_NAME'], -3) == 'SAT') continue;
- if (substr($row['CRS_NAME'], -2) == 'WL') continue;
- if (substr($row['CRS_NAME'], -2) == 'IB') continue;
- if (substr($row['CRS_NAME'], -2) == 'CC') continue;
- if (substr($row['CRS_NAME'], -2) == 'MP') continue;
- if (substr($row['CRS_NAME'], -2) == 'AP') continue;
- if (substr($row['CRS_NAME'], -1) == 'S') continue;
- if (substr($row['CRS_NAME'], -1) == 'L') continue;
-
- $found = false;
- $coursetableyear = $this->course_table_year;
- while ($coursetableyear > 2009)
- {
- $coursetable = 'course'.$coursetableyear;
- $query = 'SELECT IDM_COURSE.*, description, title, prereq FROM IDM_COURSE
- JOIN '.$coursetable.'
- ON '.$coursetable.'.course_id = IDM_COURSE.SEC_COURSE
- AND ('.$coursetable.'.match_title IS NULL
- OR '.$coursetable.'.match_title = IDM_COURSE.SEC_SHORT_TITLE)
- WHERE SEC_COURSE = "'.$row['COURSES_ID'].'"';
-
- if ($result2 = mysql_query($query))
- {
- if (mysql_num_rows($result2) == 1)
- {
- $row = array_merge($row, mysql_fetch_assoc($result2));
- $found = true;
- }
- else if (mysql_num_rows($result2) > 1)
- {
- $row = array_merge($row, mysql_fetch_assoc($result2));
- $found = true;
- }
- else
- {
- //echo "No data for $row[COURSES_ID] in $coursetable\n";
- $coursetableyear--;
- continue;
- }
- $data[] = $row;
- break;
- }
- else
- {
- $this->errors[] = mysql_error();
- }
- }
- if (!$found) echo "No data for $row[CRS_NAME] in catalog\n";
- }
- }
- else
- {
- $this->errors[] = mysql_error();
- }
- connectDB($restore_conn);
-
- if (isset($data)) return $data;
- }
-
- protected function get_course_section_data($org_id = null)
- {
- echo "get_course_section_data $org_id\n";
- $data = array();
- $coursetable = 'course'.$this->course_table_year;
- $restore_conn = get_current_db_connection_name();
- connectDB('reg_catalog_new');
- mysql_set_charset('utf8');
- $found = false;
- $coursetableyear = $this->course_table_year;
- $org_id_limit = ($org_id) ? ' AND SEC_SUBJECT="'.$org_id.'" ' : '';
- while ($coursetableyear > 2009)
- {
- $coursetable = 'course'.$coursetableyear;
- $query = 'SELECT s.*, description, title FROM IDM_CRS c, IDM_COURSE s
- JOIN '.$coursetable.'
- ON '.$coursetable.'.course_id = s.SEC_COURSE
- AND ('.$coursetable.'.match_title IS NULL
- OR '.$coursetable.'.match_title = s.SEC_SHORT_TITLE)
- WHERE s.SEC_COURSE = c.COURSES_ID AND
- (CRS_END_DATE IS NULL OR CRS_END_DATE > NOW())
- AND SEC_START_DATE > "2009-09-01 00:00:00" '. $org_id_limit .'
- ORDER BY SEC_NAME';
-
- if ($result = mysql_query($query))
- {
- while ($row = mysql_fetch_assoc($result))
- {
- if (isset($row['SEC_SUBJECT']) && empty($data[$row['COURSE_SECTIONS_ID']]))
- {
- if ($row['SEC_SUBJECT'] == 'OCP' || $row['SEC_SUBJECT'] == 'NORW') continue;
- if (strpos($row['SEC_NO'], 'WL') !== false) continue;
- //if (strpos($row['SEC_TERM'], 'SU') !== false) continue;
-
- $data[$row['COURSE_SECTIONS_ID']] = $row;
- }
- }
- }
- else
- {
- $this->errors[] = mysql_error();
- }
- $coursetableyear--;
- }
- connectDB($restore_conn);
- return $data;
- }
-
- protected function section_map_location($row)
- {
- $location = array();
- if ($times = explode('|', $row['XSEC_CC_MEETING_TIMES_SV']))
- {
- foreach ($times as $time)
- {
- if (preg_match('/(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)/', $time, $matches))
- {
- $location[] = $matches[1] . ' '. $matches[2];
- }
- }
- }
- return join('|', $location);
- }
-
- protected function section_map_meeting($row)
- {
- $meeting = array();
- if ($times = explode('|', $row['XSEC_CC_MEETING_TIMES_SV']))
- {
- foreach ($times as $time)
- {
- if (preg_match('/(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)/', $time, $matches))
- {
- $meeting[] = $matches[3] . ' '. $matches[4] . ' '. $matches[5];
- }
- }
- }
- return join('|', $meeting);
- }
/**
- * If both min and max credits are set, return "MIN-MAX" -- otherwise, return
- * whichever one is set, or nothing.
- */
- protected function section_map_credits($row)
- {
- $credits = array();
- if ($row['SEC_MIN_CRED']) $credits[] = $row['SEC_MIN_CRED'];
- if ($row['SEC_MAX_CRED']) $credits[] = $row['SEC_MAX_CRED'];
- return join('-', $credits);
- }
-
- protected function delete_all_course_entities()
+ * Remove all existing course template entities. Used mostly for catalog setup and testing.
+ */
+ public function delete_all_course_entities()
{
- $user = get_user_id('causal_agent');
- foreach ($this->get_existing_template_ids() as $id)
+ $user = get_user_id($this->entity_creator);
+ $ids = $this->get_existing_template_ids();
+ foreach ($ids as $id)
{
reason_expunge_entity($id, $user);
}
+ unset($ids);
}
- protected function delete_all_section_entities()
+ /**
+ * Remove all existing course section entities. Used mostly for catalog setup and testing.
+ */
+ public function delete_all_section_entities()
{
- $user = get_user_id('causal_agent');
- foreach ($this->get_existing_section_ids() as $id)
+ $user = get_user_id($this->entity_creator);
+ $ids = $this->get_existing_section_ids();
+ foreach ($ids as $id)
{
reason_expunge_entity($id, $user);
}
+ unset($ids);
+
+ // Clear any defunct relationships
+ $q = 'DELETE FROM relationship WHERE type in ('.
+ relationship_id_of('course_section_to_category') . ',' .
+ relationship_id_of('course_template_to_course_section') . ',' .
+ relationship_id_of('site_owns_course_section_type') . ',' .
+ relationship_id_of('site_borrows_course_section_type') . ')';
+ db_query( $q, 'Unable to delete relationships of entity '.$id );
}
+ /**
+ * Get all the ids of course template entities, optionally limited by the org_id value on
+ * the entity.
+ *
+ * @param string $org_id
+ * @return array
+ */
protected function get_existing_template_ids($org_id = null)
{
$es = new entity_selector();
@@ -533,6 +778,13 @@ protected function get_existing_template_ids($org_id = null)
return array();
}
+ /**
+ * Get all the ids of course section entities, optionally limited by the org_id value on
+ * the entity.
+ *
+ * @param string $org_id
+ * @return array
+ */
protected function get_existing_section_ids($org_id = null)
{
$es = new entity_selector();
@@ -544,35 +796,19 @@ protected function get_existing_section_ids($org_id = null)
return array();
}
- protected function get_template_org_ids()
- {
- return $this->get_section_org_ids();
- }
-
- protected function get_section_org_ids()
- {
- $org_ids = array();
- $q = 'SELECT DISTINCT SEC_SUBJECT FROM IDM_COURSE ORDER BY SEC_SUBJECT';
- connectDB('reg_catalog_new');
- if ($result = mysql_query($q))
- {
- while($row = mysql_fetch_assoc($result))
- $org_ids[] = $row['SEC_SUBJECT'];
- }
- connectDB(REASON_DB);
- return $org_ids;
- }
-
- function disable_output_buffering()
+ protected function disable_output_buffering()
{
- @apache_setenv('no-gzip', 1);
+ // We don't need to (and shouldn't) try to do this in command line mode
+ if (php_sapi_name() != "cli")
+ @apache_setenv('no-gzip', 1);
+
@ini_set('zlib.output_compression', 0);
@ini_set('implicit_flush', 1);
for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); }
ob_implicit_flush(1);
}
- function get_subjects()
+ public function get_reason_subjects()
{
$subjects = array();
$es = new entity_selector();
@@ -587,85 +823,29 @@ function get_subjects()
return $subjects;
}
- function import_course_blocks()
+ /**
+ * Remove all existing course blocks in a particular catalog site (designated by academic year).
+ * Used mostly for catalog setup and testing.
+ *
+ * @param int $year
+ */
+ public function delete_all_course_blocks($year)
{
- $subjects = $this->get_subjects();
- $root_id = root_finder(id_of($this->current_site));
- $rows = array();
-
- connectDB('reg_catalog');
- mysql_set_charset('utf8');
- $query = 'SELECT * FROM blocks JOIN block_types ON blocks.type = block_types.id
- WHERE YEAR = 2015 ORDER BY dept, sequence';
- if ($result = mysql_query($query))
+ if (!$site_id = id_of('academic_catalog_'.$year.'_site'))
{
- while ($row = mysql_fetch_assoc($result))
- {
- $rows[] = $row;
- }
+ echo 'No site found: academic_catalog_'.$year.'_site';
+ return;
}
- connectDB(REASON_DB);
-
- $subj = '';
- $seq = $page_seq = 1;
- foreach ($rows as $row)
- {
- if ($row['dept'] != $subj)
- {
- $subj = $row['dept'];
- $seq = 1;
- if (isset($subjects[$subj]))
- $page_name = $subjects[$subj]->get_value('name');
- else
- $page_name = $subj;
-
- $page_values = array(
- 'new' => 0,
- 'url_fragment' => strtolower($subj),
- 'custom_page' => 'catalog_subject_page',
- 'link_name' => $page_name,
- 'nav_display' => 'Yes',
- );
-
- $page_id = reason_create_entity( id_of($this->current_site), id_of('minisite_page'), get_user_id('causal_agent'), $page_name, $page_values);
- create_relationship( $page_id, $root_id, relationship_id_of('minisite_page_parent'), array('rel_sort_order'=>$page_seq),false);
-
- $page_seq++;
- }
-
- $block_name = $row['dept'] . ' ' . $row['name'];
-
- // Fix up include tags
- if (preg_match_all('/(\{\{?)([^}]+)\}\}?/', $row['content'], $matches, PREG_SET_ORDER))
+ $es = new entity_selector($site_id);
+ $es->add_type(id_of('course_catalog_block_type'));
+ if ($result = $es->get_ids())
+ {
+ $user = get_user_id($this->entity_creator);
+ foreach ($result as $id)
{
- foreach ($matches as $match)
- {
- if (preg_match('/(.*) ALL/', $match[2], $submatch))
- $key = 'org_id="'.$submatch[1].'"';
- else
- $key = 'gov_code="'.$match[2].'"';
-
- if ($match[1] == '{')
- $replace = '{descriptions '.$key.'}';
- else
- $replace = '{titles '.$key.'}';
-
- $row['content'] = str_replace($match[0], $replace, $row['content']);
- }
+ reason_expunge_entity($id, $user);
}
-
- $block_values = array(
- 'new' => 0,
- 'org_id' => $row['dept'],
- 'title' => $row['title'],
- 'block_type' => $row['name'],
- 'content' => $row['content'],
- );
-
- $block_id = reason_create_entity( id_of($this->current_site), id_of('course_catalog_block_type'), get_user_id('causal_agent'), $block_name, $block_values);
- create_relationship( $page_id, $block_id, relationship_id_of('page_to_course_catalog_block'), array('rel_sort_order'=>$seq), false);
-
}
}
}
diff --git a/reason_4.0/lib/core/scripts/upgrade/4.4_to_4.5/setup_course_support.php b/reason_4.0/lib/core/scripts/upgrade/4.4_to_4.5/setup_course_support.php
index 061d4851a..97d7d3ec9 100644
--- a/reason_4.0/lib/core/scripts/upgrade/4.4_to_4.5/setup_course_support.php
+++ b/reason_4.0/lib/core/scripts/upgrade/4.4_to_4.5/setup_course_support.php
@@ -55,6 +55,7 @@ class ReasonUpgrader_45_SetupCourseSupport implements reasonUpgraderInterface
'short_description' => array('db_type' => 'text'),
'long_description' => array('db_type' => 'text'),
'credits' => array('db_type' => 'varchar(50)'),
+ 'list_of_prerequisites' => array('db_type' => 'text'),
'academic_session' => array('db_type' => 'varchar(20)'),
'timeframe_begin' => array('db_type' => 'datetime'),
'timeframe_end' => array('db_type' => 'datetime'),
@@ -155,11 +156,6 @@ public function test()
$str = '';
if (!$this->course_template_type_exists()) $str .= 'Would create course_template type.
';
if (!$this->course_section_type_exists()) $str .= 'Would create course_section type.
';
- if (empty($str))
- {
- $str .= $this->add_indexes(); // only attempt test if both types exist to avoid crash
- }
- else $str .= 'Would attempt to add indexes to type tables.
';
return $str;
}
}
@@ -320,4 +316,4 @@ protected function course_section_type_exists()
}
}
-?>
+?>
\ No newline at end of file
diff --git a/reason_4.0/lib/core/scripts/upgrade/4.6_to_4.7/relationship_metadata.php b/reason_4.0/lib/core/scripts/upgrade/4.6_to_4.7/relationship_metadata.php
index ec5bc1c3b..ecdb541c6 100644
--- a/reason_4.0/lib/core/scripts/upgrade/4.6_to_4.7/relationship_metadata.php
+++ b/reason_4.0/lib/core/scripts/upgrade/4.6_to_4.7/relationship_metadata.php
@@ -43,10 +43,12 @@ public function description()
return "This upgrade: