api/soap/mc_issue_attachment_api.php

Rama master · réplica de lectura del repositorio original.

<?php
# MantisBT - A PHP based bugtracking system

# MantisBT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MantisBT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MantisBT.  If not, see <http://www.gnu.org/licenses/>.

/**
 * A webservice interface to Mantis Bug Tracker
 *
 * @package MantisBT
 * @copyright Copyright 2004  Victor Boctor - vboctor@users.sourceforge.net
 * @copyright Copyright 2005  MantisBT Team - mantisbt-dev@lists.sourceforge.net
 * @link http://www.mantisbt.org
 *
 * @noinspection PhpComposerExtensionStubsInspection Ignore missing ext-soap
 * @noinspection PhpUnused Ignore unused mc_* functions
 */

use Mantis\Exceptions\ClientException;
use Mantis\Exceptions\ServiceException;
use Mantis\Exceptions\StateException;

require_once( __DIR__ . '/mc_core.php' );

/**
 * Get the issue attachment with the specified id.
 *
 * @param string $p_username            The name of the user trying to access the filters.
 * @param string $p_password            The password of the user.
 * @param int    $p_issue_attachment_id The id of the attachment to be retrieved.
 *
 * @return string Base64 encoded data that represents the attachment.
 * @throws ClientException
 * @throws StateException
 */
function mc_issue_attachment_get( $p_username, $p_password, $p_issue_attachment_id ) {
	$t_user_id = mci_check_login( $p_username, $p_password );
	if( $t_user_id === false ) {
		return mci_fault_login_failed();
	}

	return mci_file_get( $p_issue_attachment_id, 'bug', $t_user_id );
}

/**
 * Add an attachment to an existing issue.
 *
 * @param string $p_username  The name of the user trying to add an attachment to an issue.
 * @param string $p_password  The password of the user.
 * @param int    $p_issue_id  The id of the issue to add the attachment to.
 * @param string $p_name      The name of the file.
 * @param string $p_file_type The mime type of the file.
 * @param string $p_content   The attachment to add (base64 encoded string).
 *
 * @return int|RestFault|SoapFault The id of the added attachment.
 *
 * @throws ClientException
 * @throws ServiceException
 */
function mc_issue_attachment_add( $p_username, $p_password, $p_issue_id, $p_name, $p_file_type, $p_content ) {
	$t_user_id = mci_check_login( $p_username, $p_password );
	if( $t_user_id === false ) {
		return mci_fault_login_failed();
	}
	if( !file_allow_bug_upload( $p_issue_id, $t_user_id ) ) {
		return mci_fault_access_denied( $t_user_id );
	}
	if( !access_has_bug_level( config_get( 'upload_bug_file_threshold' ), $p_issue_id, $t_user_id ) ) {
		return mci_fault_access_denied( $t_user_id );
	}
	return mci_file_add( $p_issue_id, $p_name, $p_content, $p_file_type, 'bug', '', '', $t_user_id );
}

/**
 * Delete an issue attachment given its id.
 *
 * @param string $p_username            The name of the user trying to add an
 *                                      attachment to an issue.
 * @param string $p_password            The password of the user.
 * @param int    $p_issue_attachment_id The id of the attachment to be deleted.
 *
 * @return bool|RestFault|SoapFault true: success, false: failure
 * @throws ClientException
 */
function mc_issue_attachment_delete( $p_username, $p_password, $p_issue_attachment_id ) {
	$t_user_id = mci_check_login( $p_username, $p_password );

	if( $t_user_id === false ) {
		return mci_fault_login_failed();
	}

	$t_command = new IssueFileDeleteCommand( [
		'query' => [
			'file_id' => $p_issue_attachment_id,
		]
	] );
	$t_command->execute();

	return true;
}