Snippets.php

<?php

# Copyright (c) 2010 - 2012  John Reese
# Copyright (c) 2012 - 2018  MantisBT Team - mantisbt-dev@lists.sourceforge.net
# Licensed under the MIT license

class SnippetsPlugin extends MantisPlugin {
	const VERSION = '2.2.2';

	public function register() {
		$this->name = plugin_lang_get("name");
		$this->description = plugin_lang_get("description");
		$this->page = "config_page";

		$this->version = self::VERSION;

		$this->requires = array(
			"MantisCore" => "2.3.0",
		);

		$this->author = "John Reese and MantisBT Team";
		$this->contact = "mantisbt-dev@lists.sourceforge.net";
		$this->url = "https://github.com/mantisbt-plugins/snippets";
	}

	public function config() {
		return array(
			"edit_global_threshold" => ADMINISTRATOR,
			"use_global_threshold" => REPORTER,
			"edit_own_threshold" => REPORTER,
			"textarea_names" => "bugnote_text",
		);
	}

	public function errors() {
		return array(
			"name_empty" => plugin_lang_get("error_name_empty"),
			"value_empty" => plugin_lang_get("error_value_empty"),
		);
	}

	public function hooks() {
		return array(
			"EVENT_MENU_ACCOUNT" => "menu_account",
			"EVENT_MENU_MANAGE" => "menu_manage",

			"EVENT_LAYOUT_RESOURCES" => "resources",

			'EVENT_REST_API_ROUTES' => 'routes',
		);
	}

	public function init() {
		require_once("Snippets.API.php");
	}

	public function menu_account($event, $user_id) {
		$t_return = array();

		if (access_has_global_level(plugin_config_get("edit_own_threshold"))) {
			$page = plugin_page("snippet_list");
			$label = plugin_lang_get("list_title");

			$t_return[] = "<a href=\"{$page}\">{$label}</a>";
		}

		if (access_has_global_level(plugin_config_get("edit_global_threshold"))) {
			$page = plugin_page("snippet_list") . Snippet::global_url();
			$label = plugin_lang_get("list_global_title");

			$t_return[] = '<a href="' . string_html_specialchars( $page ) . '">' . $label . '</a>';
		}

		return $t_return;
	}

	public function menu_manage($event, $user_id) {
		if (access_has_global_level(plugin_config_get("edit_global_threshold"))) {
			$page = plugin_page("snippet_list") . Snippet::global_url();
			$label = plugin_lang_get("list_global_title");

			return '<a href="' . string_html_specialchars( $page ) . '">' . $label . '</a>';
		}
	}

	public function resources($event) {
		return '
			<script src="' . plugin_file("jquery-textrange.js") . '"></script>
			<script src="' . plugin_file("jquery.qtip.min.js") . '"></script>
			<script src="' . plugin_file("snippets.js") . '"></script>
			<link rel="stylesheet" type="text/css" href="' . plugin_file("jquery.qtip.min.css") . '"/>
			<link rel="stylesheet" type="text/css" href="' . plugin_file("snippets.css") . '"/>';
	}

	/**
	 * Add the RESTful routes handled by this plugin.
	 *
	 * @param string $p_event_name The event name
	 * @param array  $p_event_args The event arguments
	 * @return void
	 */
	public function routes( $p_event_name, $p_event_args ) {
		$t_app = $p_event_args['app'];
		$t_plugin = $this;
		$t_app->group(
			plugin_route_group(),
			function() use ( $t_app, $t_plugin ) {
				$t_app->get( '/help', [$t_plugin, 'route_help'] );

				$t_app->get( '/data', [$t_plugin, 'route_data'] );
				$t_app->get( '/data/{bug_id}', [$t_plugin, 'route_data'] );
			}
		);
	}

	public function schema() {
		return array(
			# 2010-03-18
			array("CreateTableSQL", array(plugin_table("snippet"), "
				id			I		NOTNULL UNSIGNED AUTOINCREMENT PRIMARY,
				user_id		I		NOTNULL UNSIGNED,
				type		I		NOTNULL UNSIGNED,
				name		C(128)	NOTNULL,
				value		XL		NOTNULL
				")),
		);
	}

	/**
	 * RESTful route for Snippets Pattern Help (tooltip).
	 *
	 * Returned JSON structure
	 *   - {string} title
	 *   - {string} text
	 *
	 * @param Psr\Http\Message\ServerRequestInterface $request
	 * @param Psr\Http\Message\ResponseInterface $response
	 * @param array $args
	 * @return Psr\Http\Message\ResponseInterface
	 */
	public function route_help($request, $response, $args) {
		plugin_push_current( $this->basename );

		$t_help = array(
			'title' => plugin_lang_get( 'pattern_title' ),
			'text'  => plugin_lang_get( 'pattern_help' ),
		);

		plugin_pop_current();

		return $response
			->withStatus( HTTP_STATUS_SUCCESS )
			->withJson( $t_help );
	}

	/**
	 * RESTful route for Snippets data.
	 *
	 * Returned JSON structure:
	 * - {string}     version  - Plugin version
	 * - {string}     selector - Configured jQuery selector for textareas
	 * - {string}     label    - Language string for Snippets select's label
	 * - {string}     default  - Language string for Snippets select's default option
	 * - {null|array} snippets - List of snippets, with following structure:
	 *   - {int}      id
	 *   - {int}      user_id
	 *   - {int}      type
	 *   - {string}   name     - Snippet title
	 *   - {string}   value    - Snippet text
	 *
	 * @param Psr\Http\Message\ServerRequestInterface $request
	 * @param Psr\Http\Message\ResponseInterface $response
	 * @param array $args [bug_id = Bug Id for patterns replacement]
	 * @return Psr\Http\Message\ResponseInterface
	 */
	public function route_data( $request, $response, $args) {
		plugin_push_current( $this->basename );

		# Set the reference Bug Id for placeholders replacements
		if( isset( $args['bug_id'] ) ) {
			$t_bug_id = (int)$args['bug_id'];
		} else {
			$t_bug_id = 0;
		}

		# Load snippets available to the user
		$t_use_global = access_has_global_level( plugin_config_get( 'use_global_threshold' ) );
		$t_user_id = -1;
		if( access_has_global_level( plugin_config_get( 'edit_own_threshold' ) ) ) {
			$t_user_id = auth_get_current_user_id();
		}
		$t_snippets = Snippet::load_by_type_user( 0, $t_user_id, $t_use_global );
		$t_snippets = Snippet::clean( $t_snippets, 'form', $t_bug_id );

		# Split names of textareas found in 'textarea_names' option, and
		# make an array of "textarea[name='FIELD_NAME']" strings
		$t_selectors = array_map(
			function($name) {
				return "textarea[name='$name']";
			},
			Snippet::get_configured_field_names()
		);

		$t_data = array(
			# return configured jQuery selectors for textareas in "selector" field
			'selector' => implode( ',', $t_selectors ),
			'label' => plugin_lang_get( 'select_label' ),
			'default' => plugin_lang_get( 'select_default' ),
		);

		# Arrange the available snippets into the data array
		foreach( $t_snippets as $t_snippet ) {
			$t_data['snippets'][$t_snippet->id] = $t_snippet;
		}

		plugin_pop_current();

		return $response
			->withStatus( HTTP_STATUS_SUCCESS )
			->withJson( $t_data );
	}
}