New abstract base class for Git-based plugins

- Provides methods to validate a git branch name
- Defines error() method for corresponding error message

Author: dregad

Source/MantisSourceGitBasePlugin.class.php

@@ -0,0 +1,93 @@
+<?php
+
+# Copyright (c) 2017 Damien Regad
+# Licensed under the MIT license
+
+require_once( 'MantisSourcePlugin.class.php' );
+
+/**
+ * Class MantisSourceGitBasePlugin
+ *
+ * Base class providing common methods for all git-based Source Integration
+ * Plugin classes.
+ *
+ */
+abstract class MantisSourceGitBasePlugin extends MantisSourcePlugin
+{
+	/**
+	 * Git branch name validation regex.
+	 * Based on rules defined in man page
+	 * http://www.kernel.org/pub/software/scm/git/docs/git-check-ref-format.html
+	 */
+	private $valid_branch_regex = '%'
+		# Must not start with '/'; cannot contain '/.', '//', '@{' or '\';
+		# cannot be a single '@'.
+		. '^(?!/|.*([/.]\.|//|@\{|\\\\)|@$)'
+		# One or more chars, except the following: ASCII control, space,
+		# tilde, caret, colon, question mark, asterisk, open bracket.
+		. '[^\000-\037\177 ~^:?*[]+'
+		# Must not end with '.lock', '/' or '.'
+		. '(?<!\.lock|[/.])$'
+		. '%';
+
+	/**
+	 * Error constants
+	 */
+	const ERROR_INVALID_BRANCH = 'invalid_branch';
+
+	/**
+	 * Define plugin's Error strings
+	 * @return array
+	 */
+	public function errors() {
+		$t_errors_list = array(
+			self::ERROR_INVALID_BRANCH,
+		);
+
+		foreach( $t_errors_list as $t_error ) {
+			$t_errors[$t_error] = plugin_lang_get( 'error_' . $t_error, 'Source' );
+		}
+
+		return $t_errors;
+	}
+
+	/**
+	 * Determines if given string name is a valid git branch name.
+	 * @param string $p_branch Branch name to validate
+	 * @return bool True if valid
+	 */
+	protected function is_branch_valid( $p_branch )
+	{
+		return (bool)preg_match( $this->valid_branch_regex, $p_branch );
+	}
+
+	/**
+	 * Triggers an error if the branch is invalid
+	 * @param string $p_branch Branch name to validate
+	 * @return void
+	 */
+	protected function ensure_branch_valid( $p_branch )
+	{
+		if( !$this->is_branch_valid( $p_branch ) ) {
+			error_parameters( $p_branch );
+			plugin_error( self::ERROR_INVALID_BRANCH );
+		}
+	}
+
+	/**
+	 * Validates a comma-delimited list of git branches.
+	 * Triggers an ERROR_INVALID_BRANCH if one of the branches is invalid
+	 * @param string $p_list Comma-delimited list of branch names (or '*')
+	 * @return void
+	 */
+	protected function validate_branch_list( $p_list )
+	{
+		if( $p_list == '*' ) {
+			return;
+		}
+
+		foreach( explode( ',', $p_list ) as $t_branch ) {
+			$this->ensure_branch_valid( trim( $t_branch ) );
+		}
+	}
+}

Source/lang/strings_english.txt

@@ -147,3 +147,4 @@ $s_plugin_Source_import_full_failed = 'Full repository data importing failed.';
 
 $s_plugin_Source_changeset_column_title = 'C';
 
+$s_plugin_Source_error_invalid_branch = 'Invalid characters in Branch name "%1$s".';

Source/lang/strings_german.txt

@@ -144,3 +144,5 @@ $s_plugin_Source_import_latest_failed = 'Partieller Import des Projektarchivs fe
 $s_plugin_Source_import_full_failed = 'Vollständiger Import des Projektarchivs fehlgeschlagen.';
 
 $s_plugin_Source_changeset_column_title = 'C';
+
+$s_plugin_Source_error_invalid_branch = 'Ungültige Zeichen in der Zweige "%1$s"';