Add support for Pull Request linking

Expanding on the existing changeset linking functionality, it is now
possible to generate links to pull requests (for VCS that support it,
currently implemented only for Bitbucket and Github), using the
following syntax

p:<repo>:<PR id>

Based on an original idea by PhracturedBlue.

Fixes #116

Author: dregad

Source/MantisSourcePlugin.class.php

@@ -25,6 +25,16 @@ public function hooks() {
 	 */
 	public $configuration = false;
 
+	/**
+	 * Define the VCS's ability to handle links to Pull Requests.
+	 * If false, Pull Request links are not supported; otherwise this should be
+	 * a sprintf template used to build an URL linking to a Pull Request, by
+	 * appending it at the end of url_repo().
+	 * e.g. '/pull/%s', %s being the PR's number
+	 * @var false|string linkPullRequest
+	 */
+	public $linkPullRequest = false;
+
 	/**
 	 * Get a long, proper string representing the plugin's source control type.
 	 * Should be localized if possible.

Source/Source.API.php

@@ -394,56 +394,6 @@ function Source_Process_Changesets( $p_changesets, $p_repo=null ) {
 	event_signal( 'EVENT_SOURCE_FIXED', array( $t_fixed_bugs ) );
 }
 
-/**
- * preg_replace_callback function for working with VCS links.
- */
-function Source_Changeset_Link_Callback( $p_matches ) {
-	$t_url_type = strtolower($p_matches[1]);
-	$t_repo_name = $p_matches[2];
-	$t_revision = $p_matches[3];
-
-	$t_repo_table = plugin_table( 'repository', 'Source' );
-	$t_changeset_table = plugin_table( 'changeset', 'Source' );
-	$t_file_table = plugin_table( 'file', 'Source' );
-
-	$t_query = "SELECT c.* FROM $t_changeset_table AS c
-				JOIN $t_repo_table AS r ON r.id=c.repo_id
-				WHERE c.revision LIKE " . db_param() . '
-				AND r.name LIKE ' . db_param();
-	$t_result = db_query( $t_query, array( $t_revision . '%', $t_repo_name . '%' ), 1 );
-
-	if ( db_num_rows( $t_result ) > 0 ) {
-		$t_row = db_fetch_array( $t_result );
-
-		$t_changeset = new SourceChangeset( $t_row['repo_id'], $t_row['revision'], $t_row['branch'], $t_row['timestamp'], $t_row['author'], $t_row['message'], $t_row['user_id'] );
-		$t_changeset->id = $t_row['id'];
-
-		$t_repo = SourceRepo::load( $t_changeset->repo_id );
-		$t_vcs = SourceVCS::repo( $t_repo );
-
-		switch( $t_url_type ) {
-			case 'v':
-			case 'd':
-				$t_url = $t_vcs->url_changeset( $t_repo, $t_changeset );
-				break;
-			case 'c':
-			case 's':
-			default:
-				$t_url = plugin_page( 'view' ) . '&id=' . $t_changeset->id;
-		}
-
-		$t_name = string_display_line( $t_repo->name . ' ' . $t_vcs->show_changeset( $t_repo, $t_changeset ) );
-
-		if ( !is_blank( $t_url ) ) {
-			return '<a href="' . $t_url . '">' . $t_name . '</a>';
-		}
-
-		return $t_name;
-	}
-
-	return $p_matches[0];
-}
-
 /**
  * Object for handling registration and retrieval of VCS type extension plugins.
  */

Source/Source.php

@@ -22,7 +22,7 @@ class SourcePlugin extends MantisPlugin {
 	 * <rev>  = changeset revision ID (e.g. SVN rev number, GIT SHA, etc.)
 	 * The match is not case-sensitive.
 	 */
-	const CHANGESET_LINKING_REGEX = '/(?:([cdsv]?):([^:\s][^:\n\t]*):([^:\s]+):)/i';
+	const CHANGESET_LINKING_REGEX = '/(?:([cdsvp]?):([^:\s][^:\n\t]*):([^:\s]+):)/i';
 
 	function register() {
 		$this->name = plugin_lang_get( 'title' );
@@ -160,7 +160,7 @@ function menu_main() {
 	function display_formatted( $p_event, $p_text, $p_multiline ) {
 		$p_text = preg_replace_callback(
 			self::CHANGESET_LINKING_REGEX,
-			'Source_Changeset_Link_Callback',
+			array( $this, 'Changeset_Link_Callback' ),
 			$p_text
 		);
 		return $p_text;
@@ -246,5 +246,76 @@ function schema() {
 		);
 	}
 
+	/**
+	 * preg_replace callback to generate VCS links to changesets and pull requests.
+	 * @param string $p_matches
+	 * @return string
+	 */
+	protected function Changeset_Link_Callback( $p_matches ) {
+		$t_url_type = strtolower($p_matches[1]);
+		$t_repo_name = $p_matches[2];
+		$t_revision = $p_matches[3];
+
+		// Pull request links
+		if( $t_url_type == 'p' ) {
+			$t_repo = SourceRepo::load_by_name( $t_repo_name );
+			if( $t_repo !== null ) {
+				$t_vcs = SourceVCS::repo( $t_repo );
+				if( $t_vcs->linkPullRequest ) {
+					$t_url = $t_vcs->url_repo( $t_repo )
+						. sprintf( $t_vcs->linkPullRequest, $t_revision );
+					$t_name = string_display_line(
+						$t_repo->name . ' ' .
+						plugin_lang_get ( 'pullrequest' ) . ' ' .
+						$t_revision
+					);
+					return '<a href="' . $t_url . '">' . $t_name . '</a>';
+				}
+			}
+			return $p_matches[0];
+		}
+
+		// Changeset links
+		$t_repo_table = plugin_table( 'repository', 'Source' );
+		$t_changeset_table = plugin_table( 'changeset', 'Source' );
+
+		$t_query = "SELECT c.* FROM $t_changeset_table AS c
+			JOIN $t_repo_table AS r ON r.id=c.repo_id
+			WHERE c.revision LIKE " . db_param() . '
+			AND r.name LIKE ' . db_param();
+		$t_result = db_query( $t_query, array( $t_revision . '%', $t_repo_name . '%' ), 1 );
+
+		if( db_num_rows( $t_result ) > 0 ) {
+			$t_row = db_fetch_array( $t_result );
+
+			$t_changeset = new SourceChangeset(
+				$t_row['repo_id'], $t_row['revision'], $t_row['branch'],
+				$t_row['timestamp'], $t_row['author'], $t_row['message'],
+				$t_row['user_id']
+			);
+			$t_changeset->id = $t_row['id'];
+
+			$t_repo = SourceRepo::load( $t_changeset->repo_id );
+			$t_vcs = SourceVCS::repo( $t_repo );
+
+			switch( $t_url_type ) {
+				case 'v':
+				case 'd':
+					$t_url = $t_vcs->url_changeset( $t_repo, $t_changeset );
+					break;
+				case 'c':
+				case 's':
+				default:
+					$t_url = plugin_page( 'view' ) . '&id=' . $t_changeset->id;
+			}
+
+			$t_name = string_display_line( $t_repo->name . ' ' . $t_vcs->show_changeset( $t_repo, $t_changeset ) );
+
+			return '<a href="' . $t_url . '">' . $t_name . '</a>';
+		}
+
+		return $p_matches[0];
+	}
+
 }
 

Source/lang/strings_english.txt

@@ -14,6 +14,7 @@ $s_plugin_Source_changesets = 'Changesets';
 $s_plugin_Source_file = 'File';
 $s_plugin_Source_files = 'Files';
 $s_plugin_Source_diff = 'Diff';
+$s_plugin_Source_pullrequest = 'Pull Request';
 
 $s_plugin_Source_name = 'Name';
 $s_plugin_Source_type = 'Type';

SourceBitBucket/SourceBitBucket.php

@@ -14,6 +14,8 @@ class SourceBitBucketPlugin extends MantisSourcePlugin {
 	protected $api_url_10 = 'https://bitbucket.org/api/1.0/';
 	protected $api_url_20 = 'https://bitbucket.org/api/2.0/';
 
+	public $linkPullRequest = '/pull-request/%s';
+
 	public function register() {
 		$this->name        = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
@@ -430,4 +432,5 @@ public function url_get( $p_repo, $p_url ) {
 		$t_url = escapeshellarg( $p_url ); //use -u user:pass
 		return shell_exec( 'curl -u ' . $t_user_pass . ' ' . $t_url );
 	}
+
 }

SourceGithub/SourceGithub.php

@@ -13,6 +13,8 @@ class SourceGithubPlugin extends MantisSourcePlugin {
 
 	const ERROR_INVALID_PRIMARY_BRANCH = 'invalid_branch';
 
+	public $linkPullRequest = '/pull/%s';
+
 	public function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );