Fix #13715: Export plugin columns to CSV and Excel

vincentsels · dregad · commit a5708e062a89 · 2012-01-10T12:08:13.000+01:00
Prior to this, trying to include plugin columns in a CSV or Excel
export would generate a file containing errors:

 * CSV: "Fatal error: Call to undefined function csv_format_XXX()
   in csv_export.php on line 116"
 * excel: "Fatal error: Call to undefined function excel_format_XXX()
   in excel_xml_export.php on line 96"

where XXX is the column's name.

Signed-off-by: Damien Regad &lt;damien.regad@merckgroup.com&gt;
diff --git a/core/columns_api.php b/core/columns_api.php
@@ -190,6 +190,15 @@ function columns_get_plugin_columns() {
 	return $s_column_array;
 }
 
+/**
+ * Returns true if the specified $p_column is a plugin column.
+ * @param string $p_column A column name.
+ */
+function column_is_plugin_column( $p_column ) {
+	$t_plugin_columns = columns_get_plugin_columns();
+	return isset( $t_plugin_columns[ $p_column ] );
+}
+
 /**
  * Allow plugin columns to pre-cache data for a set of issues
  * rather than requiring repeated queries for each issue.
diff --git a/core/excel_api.php b/core/excel_api.php
@@ -498,6 +498,26 @@ function excel_format_custom_field( $p_issue_id, $p_project_id, $p_custom_field
 	return excel_prepare_string( '' );
 }
 
+/**
+ * Gets the formatted value for the specified plugin column value.
+ * @param $p_custom_field The plugin column name.
+ * @param $p_bug The bug to print the column for (needed for the display function of the plugin column).
+ * @returns The custom field value.
+ */
+function excel_format_plugin_column_value( $p_column, $p_bug ) {
+	$t_plugin_columns = columns_get_plugin_columns();
+	
+	if ( !isset( $t_plugin_columns[$p_column] ) ) {
+		return excel_prepare_string( '' );
+	} else {
+		$t_column_object = $t_plugin_columns[ $p_column ];
+		ob_start();
+		$t_column_object->display( $p_bug, COLUMNS_TARGET_EXCEL_PAGE );
+		$t_value = ob_get_clean();
+		return excel_prepare_string( $t_value );
+	}
+}
+
 /**
  * Gets the formatted due date.
  * @param $p_due_date The due date.
diff --git a/csv_export.php b/csv_export.php
@@ -62,6 +62,9 @@
 	print_header_redirect( 'view_all_set.php?type=0' );
 }
 
+# pre-cache custom column data
+columns_plugin_cache_issue_data( $t_rows );
+
 $t_filename = csv_get_default_filename();
 
 # Send headers to browser to activate mime loading
@@ -123,8 +126,7 @@
 			$t_first_column = false;
 		}
 
-		$t_custom_field = column_get_custom_field_name( $t_column );
-		if ( $t_custom_field !== null ) {
+		if ( column_get_custom_field_name( $t_column ) !== null || column_is_plugin_column( $t_column ) ) {
 			ob_start();
 			$t_column_value_function = 'print_column_value';
 			helper_call_custom_function( $t_column_value_function, array( $t_column, $t_row, COLUMNS_TARGET_CSV_PAGE ) );
diff --git a/excel_xml_export.php b/excel_xml_export.php
@@ -76,6 +76,9 @@
 	print_header_redirect( 'view_all_set.php?type=0&print=1' );
 }
 
+# pre-cache custom column data
+columns_plugin_cache_issue_data( $result );
+
 header( 'Content-Type: application/vnd.ms-excel; charset=UTF-8' );
 header( 'Pragma: public' );
 header( 'Content-Disposition: attachment; filename="' . urlencode( file_clean_name( $t_export_title ) ) . '.xml"' ) ;
@@ -111,6 +114,8 @@
 					$t_custom_field = column_get_custom_field_name( $t_column );
 					if ( $t_custom_field !== null ) {
 						echo excel_format_custom_field( $t_row->id, $t_row->project_id, $t_custom_field );
+					} else if ( column_is_plugin_column( $t_column ) ) {
+						echo excel_format_plugin_column_value( $t_column, $t_row );
 					} else {
 						$t_function = 'excel_format_' . $t_column;
 						echo $t_function( $t_row->$t_column );
diff --git a/print_all_bug_page.php b/print_all_bug_page.php
@@ -102,6 +102,9 @@
 $result = filter_get_bug_rows( $f_page_number, $t_per_page, $t_page_count, $t_bug_count );
 $row_count = count( $result );
 
+# pre-cache custom column data
+columns_plugin_cache_issue_data( $result );
+
 # for export
 $t_show_flag = gpc_get_int( 'show_flag', 0 );
 
