.
/**
* freemind export API
* see https://freemind.sourceforge.net
* it works with freemind version 0.8.0, 0.8.1
* @package CoreAPI
* @subpackage FreemindAPI
* @copyright Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright (C) 2002 - 2009 Mantis Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*/
$t_core_dir = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
/**
* requires filter_api
*/
require_once( $t_core_dir . 'filter_api.php' );
/**
* requires bug_api
*/
require_once( $t_core_dir . 'bug_api.php' );
/**
* Get the new line marker to use when export mind map files.
*/
function freemind_get_newline() {
return "\n";
}
/**
* Export issues as freemind mind map
*/
function freemind_export_map() {
$t_page_number = 1;
$t_per_page = -1;
$t_bug_count = null;
$t_page_count = null;
$t_nl = freemind_get_newline();
# Get bug rows according to the current filter
$t_rows = filter_get_bug_rows( $t_page_number, $t_per_page, $t_page_count, $t_bug_count );
if( $t_rows === false ) {
$t_rows = array();
}
$t_bug_list = freemind_find_descendents( $t_rows );
echo '', $t_nl;
}
/**
* Write the bug and all of its descendants (children) as mm nodes
*/
function freemind_export_bug( $p_bug, &$p_bug_list ) {
$p_bug = freemind_prepare_export( $p_bug );
$t_id = $p_bug->id;
$t_summary = $p_bug->summary;
$t_handler = $p_bug->handler;
$t_reporter = $p_bug->reporter;
$t_project = $p_bug->project;
$t_category = $p_bug->category;
$t_reporter = $p_bug->reporter;
$t_nl = freemind_get_newline();
$t_line = '----------';
echo "$t_nl";
if( $p_bug->status >= CLOSED ) {
echo '', $t_nl;
} elseif( bug_is_resolved( $t_id ) ) {
echo '', $t_nl;
} elseif( $p_bug->handler_id != NO_USER ) {
echo '', $t_nl;
} else {
echo '', $t_nl;
}
echo "";
echo lang_get( 'reporter' ) . ': ', $t_reporter, $t_nl;
if( $p_bug->handler_id != NO_USER ) {
echo lang_get( 'assigned_to' ), ': ', $t_handler, $t_nl;
}
echo $t_nl;
if( !is_blank( $p_bug->description ) ) {
echo $p_bug->description, $t_nl;
}
if( !is_blank( $p_bug->steps_to_reproduce ) ) {
echo $t_nl, $t_line, $t_nl, lang_get( 'steps_to_reproduce' ), ':', $t_nl, $t_nl;
echo $p_bug->steps_to_reproduce, $t_nl;
}
if( !is_blank( $p_bug->additional_information ) ) {
echo $t_nl, $t_line, $t_nl, lang_get( 'additional_information' ), ':', $t_nl, $t_nl;
echo $p_bug->additional_information, $t_nl;
}
echo "$t_nl";
# add sub nodes and arrows for relationships
if( !empty( $p_bug->related_to ) ) {
echo "\t$t_nl";
foreach( $p_bug->related_to as $t_rel_id ) {
$t_rel_link = "#Freemind_Link_$t_rel_id";
# if related issue is not included, add link to mantis instead of relative link
if( !$p_bug_list[$t_rel_id] ) {
$t_rel_link = string_get_bug_view_url_with_fqdn( $t_rel_id );
}
echo "\tsummary, "\"", " LINK=\"$t_rel_link\"", " >$t_nl";
echo "\t$t_nl";
echo "\t$t_nl";
}
echo "\t$t_nl";
}
# look for attached files and include a subnode "files" that contains links to all files
if( file_bug_has_attachments( $t_id ) ) {
echo "\t$t_nl";
foreach( file_get_visible_attachments( $t_id ) as $t_attachment ) {
echo "\t\t$t_nl";
}
echo "\t$t_nl";
}
# @@@ look for all links in summary, description, ... and create additional link subnotes for each
# Now put all children here
foreach( $p_bug->children as $t_child_id ) {
freemind_export_bug( $p_bug_list[$t_child_id], $p_bug_list );
}
echo '', $t_nl, $t_nl;
}
/**
* Convert to a string that can be written to a mm note (hook)
*/
function freemind_note_display( $p_string ) {
$t_string = $p_string;
$t_string = string_strip_hrefs( $t_string );
$t_string = string_html_specialchars( $t_string );
$t_string = preg_replace( "/\n/", "
", $t_string );
return $t_string;
}
/**
* Convert all fields of the bug to a string that can be exported as mm
*/
function freemind_prepare_export( $p_bug_data ) {
$p_bug_data->category = freemind_note_display( category_full_name( $p_bug_data->category_id, false ) );
$p_bug_data->date_submitted = freemind_note_display( $p_bug_data->date_submitted );
$p_bug_data->last_updated = freemind_note_display( $p_bug_data->last_updated );
$p_bug_data->os = freemind_note_display( $p_bug_data->os );
$p_bug_data->os_build = freemind_note_display( $p_bug_data->os_build );
$p_bug_data->platform = freemind_note_display( $p_bug_data->platform );
$p_bug_data->version = freemind_note_display( $p_bug_data->version );
$p_bug_data->build = freemind_note_display( $p_bug_data->build );
$p_bug_data->target_version = freemind_note_display( $p_bug_data->target_version );
$p_bug_data->fixed_in_version = freemind_note_display( $p_bug_data->fixed_in_version );
$p_bug_data->summary = freemind_note_display( $p_bug_data->summary );
$p_bug_data->sponsorship_total = freemind_note_display( $p_bug_data->sponsorship_total );
$p_bug_data->sticky = freemind_note_display( $p_bug_data->sticky );
$p_bug_data->description = freemind_note_display( $p_bug_data->description );
$p_bug_data->steps_to_reproduce = freemind_note_display( $p_bug_data->steps_to_reproduce );
$p_bug_data->additional_information = freemind_note_display( $p_bug_data->additional_information );
$p_bug_data->handler = freemind_note_display( user_get_name( $p_bug_data->handler_id ) );
$p_bug_data->reporter = freemind_note_display( user_get_name( $p_bug_data->reporter_id ) );
$p_bug_data->project = freemind_note_display( project_get_field( $p_bug_data->project_id, 'name' ) );
$p_bug_data->reproducibility = freemind_note_display( get_enum_element( 'reproducibility', $p_bug_data->reproducibility ) );
return $p_bug_data;
}
/**
* Go through all bugs in the filtered bug list and find their parents and children.
* this is used to be able to find the "root" nodes (without parents) and to be
* able to export the children as subnodes in mm
*/
function freemind_find_descendents( &$p_rows ) {
# List of visited issues and their data.
$v_bug_list = array();
foreach( $p_rows as $t_row ) {
$t_bug_id = $t_row['id'];
$t_bug = bug_get( $t_bug_id, true );
$v_bug_list[$t_bug_id] = $t_bug;
$v_bug_list[$t_bug_id]->id = $t_bug_id;
$v_bug_list[$t_bug_id]->parents = array();
$v_bug_list[$t_bug_id]->children = array();
$v_bug_list[$t_bug_id]->related_to = array();
}
foreach( array_keys( $v_bug_list ) as $t_bug_id ) {
$t_relationships = relationship_get_all_dest( $t_bug_id );
foreach( $t_relationships as $t_relationship ) {
if( $t_relationship->type == BUG_DEPENDANT ) {
if( array_key_exists( $t_relationship->src_bug_id, $v_bug_list ) ) {
array_push( $v_bug_list[$t_bug_id]->parents, $t_relationship->src_bug_id );
}
}
elseif( $t_relationship->type == BUG_RELATED ) {
array_push( $v_bug_list[$t_bug_id]->related_to, $t_relationship->src_bug_id );
}
}
$t_relationships = relationship_get_all_src( $t_bug_id );
foreach( $t_relationships as $t_relationship ) {
if( $t_relationship->type == BUG_DEPENDANT ) {
if( array_key_exists( $t_relationship->dest_bug_id, $v_bug_list ) ) {
$v_bug_list[$t_bug_id]->children[] = $t_relationship->dest_bug_id;
}
}
elseif( $t_relationship->type == BUG_RELATED ) {
array_push( $v_bug_list[$t_bug_id]->related_to, $t_relationship->dest_bug_id );
}
}
}
return $v_bug_list;
}