Use more descriptive placeholders

Fixes #10

Author: vboctor

README.md

@@ -43,10 +43,10 @@ replaced by the corresponding contents when inserted:
 
  Placeholder | Description
 :-----------:|-------------------------
-%u           | your username
-%r           | the bug reporter's name
-%h           | the bug handler's name
-%p           | the project name
+{user}       | your username
+{reporter}   | the bug reporter's name
+{handler}    | the bug handler's name
+{project}    | the project name
 
 
 ### Using Snippets

Snippets/Snippets.API.php

@@ -4,6 +4,11 @@
 # Copyright (c) 2012 - 2014  MantisBT Team - [email protected]
 # Licensed under the MIT license
 
+define( 'PLACEHOLDER_USER', '{user}' );
+define( 'PLACEHOLDER_REPORTER', '{reporter}' );
+define( 'PLACEHOLDER_HANDLER', '{handler}' );
+define( 'PLACEHOLDER_PROJECT', '{project}' );
+
 function xmlhttprequest_plugin_snippets_text() {
 	plugin_push_current("Snippets");
 
@@ -185,7 +190,7 @@ public static function clean($dirty, $target="view", $pattern=false) {
 	 * @return array Updated snippet objects
 	 */
 	public static function patterns($snippets, $bug_id) {
-		$handler = '%h';
+		$handler = PLACEHOLDER_HANDLER;
 
 		$current_user = auth_get_current_user_id();
 
@@ -209,7 +214,7 @@ public static function patterns($snippets, $bug_id) {
 
 		foreach ($snippets as $snippet) {
 			$snippet->value = str_replace(
-				array('%u', '%r', '%h', '%p'),
+				array(PLACEHOLDER_USER, PLACEHOLDER_REPORTER, PLACEHOLDER_HANDLER, PLACEHOLDER_PROJECT),
 				array($username, $reporter, $handler, $project),
 				$snippet->value);
 		}
@@ -334,7 +339,11 @@ public static function delete_by_user_id($user_id) {
 	private static function from_db_result($result) {
 		$snippets = array();
 		while ($row = db_fetch_array($result)) {
-			$snippet = new Snippet($row["type"], $row["name"], $row["value"], $row["user_id"]);
+			$snippet = new Snippet(
+				$row['type'],
+				$row['name'],
+				Snippet::replace_legacy_placeholders($row['value']),
+				$row['user_id']);
 			$snippet->id = $row["id"];
 
 			$snippets[$row["id"]] = $snippet;
@@ -343,6 +352,21 @@ private static function from_db_result($result) {
 		return $snippets;
 	}
 
+	/**
+	 * Replace legacy placeholders (e.g. %u) with modern ones (e.g. {user}).
+	 *
+	 * @param string $p_value The snippet to process.
+	 * @return string The processed snippet.
+	 */
+	private static function replace_legacy_placeholders($p_value) {
+		$t_value = $p_value;
+		$t_value = str_replace('%u', PLACEHOLDER_USER,     $t_value);
+		$t_value = str_replace('%r', PLACEHOLDER_REPORTER, $t_value);
+		$t_value = str_replace('%h', PLACEHOLDER_HANDLER,  $t_value);
+		$t_value = str_replace('%p', PLACEHOLDER_PROJECT,  $t_value);
+		return $t_value;        
+	}
+
 	public static function global_url($p_is_global = true) {
 		if ($p_is_global) {
 			return '&global=true';

Snippets/lang/strings_english.txt

@@ -47,10 +47,10 @@ $s_plugin_Snippets_pattern_help = '
 	with contextual data when pasted into a text field. The following<br/>
 	placeholders are supported:<br/>
 	<table>
-	<tr><td><strong>%u</strong></td><td>Your username</td></tr>
-	<tr><td><strong>%r</strong></td><td>Bug reporter\'s name</td></tr>
-	<tr><td><strong>%h</strong></td><td>Bug handler\'s name</td></tr>
-	<tr><td><strong>%p</strong></td><td>Project name</td></tr>
+	<tr><td><strong>{user}</strong></td><td>Your username</td></tr>
+	<tr><td><strong>{reporter}</strong></td><td>Bug reporter\'s name</td></tr>
+	<tr><td><strong>{handler}</strong></td><td>Bug handler\'s name</td></tr>
+	<tr><td><strong>{project}</strong></td><td>Project name</td></tr>
 	</table>
 	';
 

Snippets/lang/strings_french.txt

@@ -47,10 +47,10 @@ $s_plugin_Snippets_pattern_help = '
 	des données contextuelles lors de leur insertion dans un champ texte.<br/>
 	Les marqueurs suivants sont pris en compte :<br/>
 	<table>
-	<tr><td><strong>%u</strong></td><td>Votre nom d\'utilisateur</td></tr>
-	<tr><td><strong>%r</strong></td><td>Le nom du rapporteur de la demande</td></tr>
-	<tr><td><strong>%h</strong></td><td>Le nom de celui à qui la demande est affectée</td></tr>
-	<tr><td><strong>%p</strong></td><td>Le nom du projet</td></tr>
+	<tr><td><strong>{user}</strong></td><td>Votre nom d\'utilisateur</td></tr>
+	<tr><td><strong>{reporter}</strong></td><td>Le nom du rapporteur de la demande</td></tr>
+	<tr><td><strong>{handler}</strong></td><td>Le nom de celui à qui la demande est affectée</td></tr>
+	<tr><td><strong>{project}</strong></td><td>Le nom du projet</td></tr>
 	</table>
 	';
 

Snippets/lang/strings_german.txt

@@ -47,10 +47,10 @@ $s_plugin_Snippets_pattern_help = '
 	ein Textfeld durch einen aktuellen Wert ersetzt werden<br/>
 	Die folgenden Platzhalter werden unterstützt:<br/>
 	<table>
-	<tr><td><strong>%u</strong></td><td>Ihr Benutzername</td></tr>
-	<tr><td><strong>%r</strong></td><td>Benutzername des Reporters</td></tr>
-	<tr><td><strong>%h</strong></td><td>Benutzername dem der Eintrag zugeordnet ist</td></tr>
-	<tr><td><strong>%p</strong></td><td>Projektname</td></tr>
+	<tr><td><strong>{user}</strong></td><td>Ihr Benutzername</td></tr>
+	<tr><td><strong>{reporter}</strong></td><td>Benutzername des Reporters</td></tr>
+	<tr><td><strong>{handler}</strong></td><td>Benutzername dem der Eintrag zugeordnet ist</td></tr>
+	<tr><td><strong>{project}</strong></td><td>Projektname</td></tr>
 	</table>
 	';