Expand redMCP safe issue operations and HTTP handling
This commit is contained in:
Jason Thistlethwaite
+459
-19
@@ -4,6 +4,7 @@ declare(strict_types=1);
|
||||
|
||||
namespace RedMCP;
|
||||
|
||||
use Redmine\Client\Client;
|
||||
use Redmine\Client\NativeCurlClient;
|
||||
use Redmine\Http\HttpClient;
|
||||
use Redmine\Http\HttpFactory;
|
||||
@@ -14,9 +15,9 @@ use Throwable;
|
||||
|
||||
final class RedmineClient
|
||||
{
|
||||
private NativeCurlClient $client;
|
||||
private Client $client;
|
||||
|
||||
public function __construct(NativeCurlClient $client)
|
||||
public function __construct(Client $client)
|
||||
{
|
||||
$this->client = $client;
|
||||
}
|
||||
@@ -236,8 +237,8 @@ final class RedmineClient
|
||||
* Create a Redmine issue.
|
||||
*
|
||||
* Typical fields include project_id, subject, description, tracker_id,
|
||||
* status_id, priority_id, assigned_to_id, category_id, due_date, and
|
||||
* start_date.
|
||||
* status_id, priority_id, assigned_to_id, category_id, parent_issue_id,
|
||||
* parent_id, uploads, due_date, and start_date.
|
||||
*
|
||||
* @param array<string,mixed> $fields
|
||||
*
|
||||
@@ -249,11 +250,9 @@ final class RedmineClient
|
||||
throw new RuntimeException('Creating an issue requires at least project_id and subject.');
|
||||
}
|
||||
|
||||
$issueApi = $this->client->getApi('issue');
|
||||
$response = $issueApi->create($fields);
|
||||
$this->assertLastApiResponseSucceeded($issueApi, 'create issue');
|
||||
$response = $this->postJson('/issues', ['issue' => $fields]);
|
||||
|
||||
return $this->xmlResponseToArray($response);
|
||||
return is_array($response['issue'] ?? null) ? $response['issue'] : $response;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -265,7 +264,8 @@ final class RedmineClient
|
||||
* sendHelpdeskIssueResponse() directly.
|
||||
*
|
||||
* Typical fields include notes, subject, status_id, priority_id,
|
||||
* assigned_to_id, private_notes, due_date, and tracker_id.
|
||||
* assigned_to_id, private_notes, parent_issue_id, parent_id, category_id,
|
||||
* uploads, due_date, and tracker_id.
|
||||
*
|
||||
* @param array<string,mixed> $fields
|
||||
*/
|
||||
@@ -294,13 +294,383 @@ final class RedmineClient
|
||||
return true;
|
||||
}
|
||||
|
||||
$issueApi = $this->client->getApi('issue');
|
||||
$issueApi->update($issueId, $fields);
|
||||
$this->assertLastApiResponseSucceeded($issueApi, 'update issue #' . $issueId);
|
||||
$this->putJson('/issues/' . rawurlencode((string) $issueId), ['issue' => $fields]);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function issueWithStructure(int $issueId): array
|
||||
{
|
||||
return $this->issue($issueId, ['journals', 'attachments', 'children', 'relations']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function listIssueChildren(int $issueId, array $params = []): array
|
||||
{
|
||||
return $this->listIssues(['parent_id' => $issueId] + $params);
|
||||
}
|
||||
|
||||
public function setIssueParent(int $issueId, int $parentIssueId): bool
|
||||
{
|
||||
if ($parentIssueId <= 0) {
|
||||
throw new RuntimeException('Setting an issue parent requires a positive parent_issue_id.');
|
||||
}
|
||||
|
||||
return $this->updateIssue($issueId, ['parent_issue_id' => $parentIssueId]);
|
||||
}
|
||||
|
||||
public function clearIssueParent(int $issueId): bool
|
||||
{
|
||||
return $this->updateIssue($issueId, ['parent_issue_id' => null]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function listIssueRelations(int $issueId): array
|
||||
{
|
||||
return $this->getJson('/issues/' . rawurlencode((string) $issueId) . '/relations') ?? [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function issueRelation(int $relationId): array
|
||||
{
|
||||
if ($relationId <= 0) {
|
||||
throw new RuntimeException('Fetching an issue relation requires a positive relation id.');
|
||||
}
|
||||
|
||||
$response = $this->getJson('/relations/' . rawurlencode((string) $relationId));
|
||||
if (!is_array($response)) {
|
||||
throw new RuntimeException('Could not fetch issue relation #' . $relationId . '.');
|
||||
}
|
||||
|
||||
return $response['relation'] ?? $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $fields
|
||||
*
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function createIssueRelation(int $issueId, array $fields): array
|
||||
{
|
||||
if (!isset($fields['issue_to_id']) || (int) $fields['issue_to_id'] <= 0) {
|
||||
throw new RuntimeException('Creating an issue relation requires a positive issue_to_id.');
|
||||
}
|
||||
|
||||
$fields += ['relation_type' => 'relates'];
|
||||
$response = $this->postJson('/issues/' . rawurlencode((string) $issueId) . '/relations', ['relation' => $fields]);
|
||||
|
||||
return is_array($response['relation'] ?? null) ? $response['relation'] : $response;
|
||||
}
|
||||
|
||||
public function removeIssueRelation(int $relationId): bool
|
||||
{
|
||||
if ($relationId <= 0) {
|
||||
throw new RuntimeException('Removing an issue relation requires a positive relation id.');
|
||||
}
|
||||
|
||||
$this->deleteJson('/relations/' . rawurlencode((string) $relationId));
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function listProjectIssueCategories(int|string $projectId): array
|
||||
{
|
||||
$projectId = trim((string) $projectId);
|
||||
if ($projectId === '') {
|
||||
throw new RuntimeException('Listing issue categories requires a project id or identifier.');
|
||||
}
|
||||
|
||||
return $this->getJson('/projects/' . rawurlencode($projectId) . '/issue_categories') ?? [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function issueCategory(int $categoryId): array
|
||||
{
|
||||
if ($categoryId <= 0) {
|
||||
throw new RuntimeException('Fetching an issue category requires a positive category id.');
|
||||
}
|
||||
|
||||
$response = $this->getJson('/issue_categories/' . rawurlencode((string) $categoryId));
|
||||
if (!is_array($response)) {
|
||||
throw new RuntimeException('Could not fetch issue category #' . $categoryId . '.');
|
||||
}
|
||||
|
||||
return $response['issue_category'] ?? $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $fields
|
||||
*
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function createIssueCategory(int|string $projectId, array $fields): array
|
||||
{
|
||||
$projectId = trim((string) $projectId);
|
||||
if ($projectId === '') {
|
||||
throw new RuntimeException('Creating an issue category requires a project id or identifier.');
|
||||
}
|
||||
if (!isset($fields['name']) || trim((string) $fields['name']) === '') {
|
||||
throw new RuntimeException('Creating an issue category requires a non-empty name.');
|
||||
}
|
||||
|
||||
$response = $this->postJson('/projects/' . rawurlencode($projectId) . '/issue_categories', ['issue_category' => $fields]);
|
||||
|
||||
return is_array($response['issue_category'] ?? null) ? $response['issue_category'] : $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $fields
|
||||
*
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function updateIssueCategory(int $categoryId, array $fields): array
|
||||
{
|
||||
if ($fields === []) {
|
||||
throw new RuntimeException('Updating an issue category requires at least one field.');
|
||||
}
|
||||
|
||||
$response = $this->putJson('/issue_categories/' . rawurlencode((string) $categoryId), ['issue_category' => $fields]);
|
||||
|
||||
return is_array($response['issue_category'] ?? null) ? $response['issue_category'] : $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function attachment(int $attachmentId): array
|
||||
{
|
||||
if ($attachmentId <= 0) {
|
||||
throw new RuntimeException('Fetching an attachment requires a positive attachment id.');
|
||||
}
|
||||
|
||||
$response = $this->getJson('/attachments/' . rawurlencode((string) $attachmentId));
|
||||
if (!is_array($response)) {
|
||||
throw new RuntimeException('Could not fetch attachment #' . $attachmentId . '.');
|
||||
}
|
||||
|
||||
return $response['attachment'] ?? $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $source
|
||||
*
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function uploadAttachment(array $source): array
|
||||
{
|
||||
$source = $this->normalizeAttachmentUploadSource($source);
|
||||
$filename = isset($source['filename']) ? trim((string) $source['filename']) : '';
|
||||
$contentType = trim((string) ($source['content_type'] ?? 'application/octet-stream'));
|
||||
if ($contentType === '') {
|
||||
$contentType = 'application/octet-stream';
|
||||
}
|
||||
|
||||
if (isset($source['path'])) {
|
||||
$path = (string) $source['path'];
|
||||
if (!is_file($path) || !is_readable($path)) {
|
||||
throw new RuntimeException('Uploading an attachment from path requires a readable local file.');
|
||||
}
|
||||
$bytes = file_get_contents($path);
|
||||
if ($bytes === false) {
|
||||
throw new RuntimeException('Could not read attachment file: ' . $path);
|
||||
}
|
||||
if ($filename === '') {
|
||||
$filename = basename($path);
|
||||
}
|
||||
} elseif (isset($source['base64_content'])) {
|
||||
if ($filename === '') {
|
||||
throw new RuntimeException('Uploading base64 attachment content requires filename.');
|
||||
}
|
||||
$decoded = base64_decode((string) $source['base64_content'], true);
|
||||
if ($decoded === false) {
|
||||
throw new RuntimeException('Attachment base64_content is not valid base64.');
|
||||
}
|
||||
$bytes = $decoded;
|
||||
} else {
|
||||
throw new RuntimeException('Uploading an attachment requires either path or base64_content.');
|
||||
}
|
||||
|
||||
if ($filename === '') {
|
||||
throw new RuntimeException('Uploading an attachment requires filename.');
|
||||
}
|
||||
|
||||
$response = $this->rawRequest(
|
||||
'POST',
|
||||
PathSerializer::create('/uploads.json', ['filename' => $filename])->getPath(),
|
||||
'application/octet-stream',
|
||||
$bytes
|
||||
);
|
||||
$status = $response->getStatusCode();
|
||||
if ($status >= 400) {
|
||||
throw new RuntimeException('Redmine upload failed with HTTP ' . $status . ': ' . $response->getContent());
|
||||
}
|
||||
|
||||
$decoded = $this->decodeJsonResponse($response, 'Redmine upload');
|
||||
$upload = is_array($decoded['upload'] ?? null) ? $decoded['upload'] : $decoded;
|
||||
if (isset($source['description'])) {
|
||||
$upload['description'] = (string) $source['description'];
|
||||
}
|
||||
$upload += [
|
||||
'filename' => $filename,
|
||||
'content_type' => $contentType,
|
||||
];
|
||||
|
||||
return $upload;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $source
|
||||
*
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
private function normalizeAttachmentUploadSource(array $source): array
|
||||
{
|
||||
if (isset($source['file']) && is_array($source['file'])) {
|
||||
$file = $source['file'];
|
||||
unset($source['file']);
|
||||
foreach ([
|
||||
'path' => 'path',
|
||||
'filename' => 'filename',
|
||||
'name' => 'filename',
|
||||
'content_type' => 'content_type',
|
||||
'mime_type' => 'content_type',
|
||||
'mimeType' => 'content_type',
|
||||
'media_type' => 'content_type',
|
||||
'description' => 'description',
|
||||
'base64_content' => 'base64_content',
|
||||
'base64' => 'base64_content',
|
||||
'data' => 'base64_content',
|
||||
'blob' => 'base64_content',
|
||||
'data_url' => 'data_url',
|
||||
'url' => 'data_url',
|
||||
] as $from => $to) {
|
||||
if (!isset($source[$to]) && isset($file[$from])) {
|
||||
$source[$to] = $file[$from];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach ([
|
||||
'name' => 'filename',
|
||||
'mime_type' => 'content_type',
|
||||
'mimeType' => 'content_type',
|
||||
'media_type' => 'content_type',
|
||||
'base64' => 'base64_content',
|
||||
'data' => 'base64_content',
|
||||
'blob' => 'base64_content',
|
||||
] as $from => $to) {
|
||||
if (!isset($source[$to]) && isset($source[$from])) {
|
||||
$source[$to] = $source[$from];
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($source['data_url']) || (isset($source['base64_content']) && str_starts_with((string) $source['base64_content'], 'data:'))) {
|
||||
$dataUrl = (string) ($source['data_url'] ?? $source['base64_content']);
|
||||
$parsed = $this->parseAttachmentDataUrl($dataUrl);
|
||||
$source['base64_content'] = $parsed['base64_content'];
|
||||
if (!isset($source['content_type'])) {
|
||||
$source['content_type'] = $parsed['content_type'];
|
||||
}
|
||||
if (!isset($source['filename']) || trim((string) $source['filename']) === '') {
|
||||
$source['filename'] = $this->defaultAttachmentFilename((string) $source['content_type']);
|
||||
}
|
||||
}
|
||||
|
||||
return $source;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array{content_type:string,base64_content:string}
|
||||
*/
|
||||
private function parseAttachmentDataUrl(string $dataUrl): array
|
||||
{
|
||||
if (!preg_match('/^data:([^;,]+)?(?:;[^,]*)?;base64,(.*)$/s', $dataUrl, $matches)) {
|
||||
throw new RuntimeException('Attachment data_url must be a base64 data URL.');
|
||||
}
|
||||
|
||||
$contentType = trim($matches[1] !== '' ? $matches[1] : 'application/octet-stream');
|
||||
|
||||
return [
|
||||
'content_type' => $contentType !== '' ? $contentType : 'application/octet-stream',
|
||||
'base64_content' => $matches[2],
|
||||
];
|
||||
}
|
||||
|
||||
private function defaultAttachmentFilename(string $contentType): string
|
||||
{
|
||||
return match (strtolower($contentType)) {
|
||||
'application/pdf' => 'attachment.pdf',
|
||||
'text/plain' => 'attachment.txt',
|
||||
'text/csv' => 'attachment.csv',
|
||||
'application/json' => 'attachment.json',
|
||||
'image/jpeg' => 'attachment.jpg',
|
||||
'image/png' => 'attachment.png',
|
||||
'image/gif' => 'attachment.gif',
|
||||
default => 'attachment.bin',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function updateAttachment(int $attachmentId, array $fields): array
|
||||
{
|
||||
if ($fields === []) {
|
||||
throw new RuntimeException('Updating an attachment requires at least one field.');
|
||||
}
|
||||
|
||||
$response = $this->putJson('/attachments/' . rawurlencode((string) $attachmentId), ['attachment' => $fields]);
|
||||
|
||||
return is_array($response['attachment'] ?? null) ? $response['attachment'] : $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
public function downloadAttachment(int $attachmentId, string $destinationPath, bool $includeBase64 = false, int $maxBase64Bytes = 262144): array
|
||||
{
|
||||
$destinationPath = $this->safeDownloadPath($destinationPath);
|
||||
$response = $this->rawRequest('GET', '/attachments/download/' . rawurlencode((string) $attachmentId));
|
||||
$status = $response->getStatusCode();
|
||||
if ($status >= 400) {
|
||||
throw new RuntimeException('Redmine attachment download failed with HTTP ' . $status . ': ' . $response->getContent());
|
||||
}
|
||||
|
||||
$bytes = $response->getContent();
|
||||
if (file_put_contents($destinationPath, $bytes) === false) {
|
||||
throw new RuntimeException('Could not write attachment download to ' . $destinationPath . '.');
|
||||
}
|
||||
|
||||
$result = [
|
||||
'attachment_id' => $attachmentId,
|
||||
'path' => $destinationPath,
|
||||
'bytes' => strlen($bytes),
|
||||
'content_type' => $response->getContentType(),
|
||||
];
|
||||
if ($includeBase64 && strlen($bytes) <= $maxBase64Bytes) {
|
||||
$result['base64_content'] = base64_encode($bytes);
|
||||
} elseif ($includeBase64) {
|
||||
$result['base64_omitted'] = true;
|
||||
$result['base64_limit_bytes'] = $maxBase64Bytes;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a Helpdesk email response for an existing Helpdesk-backed issue.
|
||||
*
|
||||
@@ -498,22 +868,67 @@ final class RedmineClient
|
||||
*/
|
||||
private function postJson(string $path, array $payload): array
|
||||
{
|
||||
if (!$this->client instanceof HttpClient) {
|
||||
throw new RuntimeException('Configured Redmine client cannot issue raw HTTP requests.');
|
||||
}
|
||||
|
||||
$requestPath = $this->buildPath($path, []);
|
||||
$encoded = json_encode($payload);
|
||||
if ($encoded === false) {
|
||||
throw new RuntimeException('Could not encode Redmine POST payload.');
|
||||
}
|
||||
|
||||
$response = $this->client->request(HttpFactory::makeJsonRequest('POST', $requestPath, $encoded));
|
||||
$response = $this->rawRequest('POST', $requestPath, 'application/json', $encoded);
|
||||
$status = $response->getStatusCode();
|
||||
if ($status >= 400) {
|
||||
throw new RuntimeException('Redmine POST ' . $requestPath . ' failed with HTTP ' . $status . ': ' . $response->getContent());
|
||||
}
|
||||
|
||||
return $this->decodeJsonResponse($response, 'Redmine POST ' . $requestPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $payload
|
||||
*
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
private function putJson(string $path, array $payload): array
|
||||
{
|
||||
$requestPath = $this->buildPath($path, []);
|
||||
$encoded = json_encode($payload);
|
||||
if ($encoded === false) {
|
||||
throw new RuntimeException('Could not encode Redmine PUT payload.');
|
||||
}
|
||||
|
||||
$response = $this->rawRequest('PUT', $requestPath, 'application/json', $encoded);
|
||||
$status = $response->getStatusCode();
|
||||
if ($status >= 400) {
|
||||
throw new RuntimeException('Redmine PUT ' . $requestPath . ' failed with HTTP ' . $status . ': ' . $response->getContent());
|
||||
}
|
||||
|
||||
return $this->decodeJsonResponse($response, 'Redmine PUT ' . $requestPath);
|
||||
}
|
||||
|
||||
private function deleteJson(string $path): void
|
||||
{
|
||||
$requestPath = $this->buildPath($path, []);
|
||||
$response = $this->rawRequest('DELETE', $requestPath);
|
||||
$status = $response->getStatusCode();
|
||||
if ($status >= 400) {
|
||||
throw new RuntimeException('Redmine DELETE ' . $requestPath . ' failed with HTTP ' . $status . ': ' . $response->getContent());
|
||||
}
|
||||
}
|
||||
|
||||
private function rawRequest(string $method, string $path, string $contentType = '', string $content = ''): \Redmine\Http\Response
|
||||
{
|
||||
if (!$this->client instanceof HttpClient) {
|
||||
throw new RuntimeException('Configured Redmine client cannot issue raw HTTP requests.');
|
||||
}
|
||||
|
||||
return $this->client->request(HttpFactory::makeRequest($method, $path, $contentType, $content));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string,mixed>
|
||||
*/
|
||||
private function decodeJsonResponse(\Redmine\Http\Response $response, string $action): array
|
||||
{
|
||||
$body = $response->getContent();
|
||||
if ($body === '') {
|
||||
return [];
|
||||
@@ -522,11 +937,11 @@ final class RedmineClient
|
||||
try {
|
||||
$decoded = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
|
||||
} catch (Throwable $exception) {
|
||||
throw new RuntimeException('Redmine POST ' . $requestPath . ' returned invalid JSON.', 0, $exception);
|
||||
throw new RuntimeException($action . ' returned invalid JSON.', 0, $exception);
|
||||
}
|
||||
|
||||
if (!is_array($decoded)) {
|
||||
throw new RuntimeException('Redmine POST ' . $requestPath . ' returned invalid JSON.');
|
||||
throw new RuntimeException($action . ' returned invalid JSON.');
|
||||
}
|
||||
|
||||
return $decoded;
|
||||
@@ -540,6 +955,31 @@ final class RedmineClient
|
||||
return PathSerializer::create($path . '.json', $params)->getPath();
|
||||
}
|
||||
|
||||
private function safeDownloadPath(string $path): string
|
||||
{
|
||||
$path = trim($path);
|
||||
if ($path === '' || str_contains($path, "\0")) {
|
||||
throw new RuntimeException('Attachment download requires a safe local destination path.');
|
||||
}
|
||||
|
||||
$directory = dirname($path);
|
||||
$realDirectory = realpath($directory);
|
||||
if ($realDirectory === false || !is_dir($realDirectory)) {
|
||||
throw new RuntimeException('Attachment download destination directory does not exist: ' . $directory);
|
||||
}
|
||||
|
||||
$resolved = $realDirectory . DIRECTORY_SEPARATOR . basename($path);
|
||||
$repoRoot = realpath(dirname(__DIR__, 2));
|
||||
$tmpRoot = realpath(sys_get_temp_dir());
|
||||
foreach (array_filter([$repoRoot, $tmpRoot]) as $allowedRoot) {
|
||||
if ($resolved === $allowedRoot || str_starts_with($resolved, $allowedRoot . DIRECTORY_SEPARATOR)) {
|
||||
return $resolved;
|
||||
}
|
||||
}
|
||||
|
||||
throw new RuntimeException('Attachment downloads must write under /tmp or the repository tree.');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $api
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user