Merge branch 'master' into modern-ui

Includes bumping of plugin versions

Author: dregad

.gitignore

@@ -4,3 +4,4 @@
 .DS_Store
 *.buildpath
 *.project
+*.idea

README.md

@@ -3,7 +3,7 @@
 [![Gitter](https://img.shields.io/gitter/room/mantisbt-plugins/source-integration.svg)](https://gitter.im/mantisbt-plugins/source-integration)
 
 Copyright (c) 2008 - 2012  John Reese - http://noswap.com  
-Copyright (c) 2012 - 2016  MantisBT Team - [email protected]
+Copyright (c) 2012 - 2017  MantisBT Team - [email protected]
 
 Released under the [MIT license](http://opensource.org/licenses/MIT)
 
@@ -26,6 +26,8 @@ plugins:
   [cgit](http://hjemli.net/git/cgit/) web frontend installation.
 * **SourceGithub**: Git repositories hosted on [GitHub](http://github.com/).
 * **SourceGitlab**: Git repositories hosted on [GitLab](https://about.gitlab.com/).
+* **SourceGitphp**: Git repositories accessible via a
+  [Gitphp](https://gitphp.org/) web frontend installation.
 * **SourceGitweb**: Git repositories accessible via a
   [GitWeb](https://git.wiki.kernel.org/index.php/Gitweb) web frontend
   installation.
@@ -53,15 +55,20 @@ version **1.3.0** or higher.
 
 ### Compatibility
 
+The Source Integration framework's version numbering follows
+[Semantic Versioning](http://semver.org/). Major version increments indicate a
+change in the minimum required MantisBT version.
+
 Depending on which version of MantisBT you are using, please make sure to
-get the source code from the appropriate branch in the Plugin's GitHub
-repository, as per the table below:
-
-MantisBT version | Branch | Notes
-:---:|---|---
-2.0.x | [modern-ui](https://github.com/mantisbt-plugins/source-integration/archive/modern-ui.zip) | Beta
-1.3.x | [master](https://github.com/mantisbt-plugins/source-integration/archive/master.zip) | **Current release**
-1.2.x | [master-1.2.x](https://github.com/mantisbt-plugins/source-integration/archive/master-1.2.x.zip) | Legacy
+get the appropriate version of the source code. 
+Use [release tags](https://github.com/mantisbt-plugins/source-integration/releases), 
+or the relevant branch in the Plugin's GitHub repository, as per the table below:
+
+MantisBT version | Tags | Branch | Notes
+:---:|---|---|---
+2.0.x | v2.* | [modern-ui](https://github.com/mantisbt-plugins/source-integration/archive/modern-ui.zip) | Beta
+1.3.x | v1.* | [master](https://github.com/mantisbt-plugins/source-integration/archive/master.zip) | **Current release**
+1.2.x | v0.* | [master-1.2.x](https://github.com/mantisbt-plugins/source-integration/archive/master-1.2.x.zip) | Legacy
 
 
 ### Setup instructions

Source/MantisSourceBase.class.php

@@ -0,0 +1,29 @@
+<?php
+
+# Copyright (c) 2017 Damien Regad
+# Licensed under the MIT license
+
+require_once( config_get_global( 'class_path' ) . 'MantisPlugin.class.php' );
+
+/**
+ * Class MantisSourceBase
+ *
+ * Base class for all Source Integration Plugin classes
+ */
+abstract class MantisSourceBase extends MantisPlugin
+{
+	/**
+	 * Source Integration framework version.
+	 *
+	 * Numbering follows Semantic Versioning. Major version increments indicate
+	 * a change in the minimum required MantisBT version: 0=1.2; 1=1.3, 2=2.x.
+	 * The framework version is incremented when the plugin's core file change.
+	 */
+	const FRAMEWORK_VERSION = '1.4.0';
+
+	/**
+	 * Minimum required MantisBT version.
+	 * Used to define the MantisCore dependency for all child plugins
+	 */
+	const MANTIS_VERSION = '1.3.0';
+}

Source/MantisSourcePlugin.class.php

@@ -3,11 +3,13 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
+require_once( 'MantisSourceBase.class.php' );
+
 /**
  * Abstract class for simplifying creation of source control plugins.
  * @author John Reese
  */
-abstract class MantisSourcePlugin extends MantisPlugin {
+abstract class MantisSourcePlugin extends MantisSourceBase {
 	public function hooks() {
 		return array(
 			'EVENT_SOURCE_INTEGRATION'		=> 'integration',
@@ -25,6 +27,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.
@@ -162,7 +174,7 @@ final public function _precommit( $p_event ) {
 class SourceGenericPlugin extends MantisSourcePlugin {
 	function register() {
 		$this->name = plugin_lang_get( 'title', 'Source' );
-		$this->version = SourcePlugin::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 	}
 
 	public $type = 'generic';