2015-05-21 17:39:11 +02:00
|
|
|
<?php namespace Todaymade\Daux\Format\Confluence;
|
|
|
|
|
|
|
|
use GuzzleHttp\Client;
|
2015-05-22 14:48:09 +02:00
|
|
|
use GuzzleHttp\Exception\BadResponseException;
|
|
|
|
use GuzzleHttp\Exception\ParseException;
|
2015-05-21 17:39:11 +02:00
|
|
|
|
2015-05-22 14:48:09 +02:00
|
|
|
class Api
|
|
|
|
{
|
2015-05-21 17:39:11 +02:00
|
|
|
protected $base_url;
|
|
|
|
protected $user;
|
|
|
|
protected $pass;
|
|
|
|
|
|
|
|
protected $space;
|
|
|
|
|
2015-05-22 14:48:09 +02:00
|
|
|
public function __construct($base_url, $user, $pass)
|
|
|
|
{
|
2015-05-21 17:39:11 +02:00
|
|
|
$this->base_url = $base_url;
|
|
|
|
$this->user = $user;
|
|
|
|
$this->pass = $pass;
|
|
|
|
}
|
|
|
|
|
2015-05-22 14:48:09 +02:00
|
|
|
public function setSpace($space_id)
|
|
|
|
{
|
2015-05-21 17:39:11 +02:00
|
|
|
$this->space = $space_id;
|
|
|
|
}
|
|
|
|
|
2015-05-22 14:48:09 +02:00
|
|
|
protected function getClient()
|
|
|
|
{
|
|
|
|
$options = [
|
|
|
|
'base_url' => $this->base_url . 'rest/api/',
|
|
|
|
'defaults' => [
|
|
|
|
'auth' => [$this->user, $this->pass]
|
|
|
|
]
|
|
|
|
];
|
|
|
|
|
|
|
|
return new Client($options);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The standard error message from guzzle is quite poor in informations,
|
|
|
|
* this will give little bit more sense to it and return it
|
|
|
|
*
|
|
|
|
* @param BadResponseException $e
|
|
|
|
* @return BadResponseException
|
|
|
|
*/
|
|
|
|
protected function handleError(BadResponseException $e)
|
|
|
|
{
|
|
|
|
$request = $e->getRequest();
|
|
|
|
$response = $e->getResponse();
|
|
|
|
|
|
|
|
$level = floor($response->getStatusCode() / 100);
|
|
|
|
|
|
|
|
if ($level == '4') {
|
|
|
|
$label = 'Client error response';
|
|
|
|
} elseif ($level == '5') {
|
|
|
|
$label = 'Server error response';
|
|
|
|
} else {
|
|
|
|
$label = 'Unsuccessful response';
|
|
|
|
}
|
|
|
|
|
|
|
|
$message = $label .
|
|
|
|
' [url] ' . $request->getUrl() .
|
|
|
|
' [status code] ' . $response->getStatusCode() .
|
|
|
|
' [message] ';
|
|
|
|
|
|
|
|
try {
|
|
|
|
$message .= $response->json()['message'];
|
|
|
|
} catch (ParseException $e) {
|
|
|
|
$message .= (string) $response->getBody();
|
|
|
|
}
|
|
|
|
|
|
|
|
return new BadResponseException($message, $request, $response, $e->getPrevious());
|
|
|
|
}
|
|
|
|
|
2015-05-22 16:15:28 +02:00
|
|
|
/**
|
2015-07-17 23:38:06 +02:00
|
|
|
* Get a list of pages
|
2015-05-22 16:15:28 +02:00
|
|
|
*
|
2015-07-17 23:38:06 +02:00
|
|
|
* @param integer $rootPage
|
|
|
|
* @param bool $recursive
|
|
|
|
* @return array
|
2015-05-22 16:15:28 +02:00
|
|
|
*/
|
2015-07-17 23:38:06 +02:00
|
|
|
public function getList($rootPage, $recursive = false)
|
2015-05-22 16:15:28 +02:00
|
|
|
{
|
2015-07-17 23:38:06 +02:00
|
|
|
$increment = 15;
|
|
|
|
|
|
|
|
// We set a limit of 15 as it appears that
|
|
|
|
// Confluence fails silently when retrieving
|
|
|
|
// more than 20 entries with "body.storage"
|
|
|
|
$base_url = $url = "content/$rootPage/child/page?expand=version,body.storage&limit=$increment";
|
|
|
|
$start = 0;
|
2015-05-22 16:15:28 +02:00
|
|
|
|
|
|
|
$pages = [];
|
|
|
|
|
|
|
|
do {
|
|
|
|
try {
|
2015-07-17 23:38:06 +02:00
|
|
|
$hierarchy = $this->getClient()->get($url)->json();
|
2015-05-22 16:15:28 +02:00
|
|
|
} catch (BadResponseException $e) {
|
|
|
|
throw $this->handleError($e);
|
|
|
|
}
|
|
|
|
|
2015-07-17 23:38:06 +02:00
|
|
|
foreach ($hierarchy['results'] as $result) {
|
2015-05-22 16:15:28 +02:00
|
|
|
$pages[$result['title']] = [
|
|
|
|
"id" => $result['id'],
|
|
|
|
"title" => $result['title'],
|
|
|
|
"version" => $result['version']['number'],
|
2015-05-22 16:35:20 +02:00
|
|
|
"content" => $result['body']['storage']['value'],
|
2015-05-22 16:15:28 +02:00
|
|
|
];
|
|
|
|
|
2015-07-17 23:38:06 +02:00
|
|
|
if ($recursive) {
|
|
|
|
$pages[$result['title']]['children'] = $this->getList($result['id'], true);
|
|
|
|
}
|
2015-05-22 16:15:28 +02:00
|
|
|
}
|
|
|
|
|
2015-07-17 23:38:06 +02:00
|
|
|
// We don't use _links->next as after ~30 elements
|
|
|
|
// it doesn't show any new elements. This seems
|
|
|
|
// to be a bug in Confluence
|
|
|
|
$start += $increment;
|
|
|
|
$url = "$base_url&start=$start";
|
|
|
|
|
|
|
|
} while (!empty($hierarchy['results']));
|
2015-05-22 16:15:28 +02:00
|
|
|
|
|
|
|
return $pages;
|
|
|
|
}
|
|
|
|
|
2015-05-21 17:39:11 +02:00
|
|
|
/**
|
2015-07-17 23:38:06 +02:00
|
|
|
* @param integer $parent_id
|
|
|
|
* @param string $title
|
|
|
|
* @param string $content
|
|
|
|
* @return integer
|
2015-05-21 17:39:11 +02:00
|
|
|
*/
|
2015-05-22 14:48:09 +02:00
|
|
|
public function createPage($parent_id, $title, $content)
|
|
|
|
{
|
2015-05-21 17:39:11 +02:00
|
|
|
$body = [
|
|
|
|
'type' => 'page',
|
|
|
|
'space' => ['key' => $this->space],
|
|
|
|
'ancestors' => [['type' => 'page', 'id' => $parent_id]],
|
|
|
|
'title' => $title,
|
|
|
|
'body' => ['storage' => ['value' => $content, 'representation' => 'storage']]
|
|
|
|
];
|
|
|
|
|
2015-05-22 14:48:09 +02:00
|
|
|
try {
|
2015-07-17 23:38:06 +02:00
|
|
|
$response = $this->getClient()->post('content', ['json' => $body])->json();
|
2015-05-22 14:48:09 +02:00
|
|
|
} catch (BadResponseException $e) {
|
|
|
|
throw $this->handleError($e);
|
|
|
|
}
|
2015-05-21 17:39:11 +02:00
|
|
|
|
|
|
|
return $response['id'];
|
|
|
|
}
|
|
|
|
|
2015-07-17 23:38:06 +02:00
|
|
|
/**
|
|
|
|
* @param integer $parent_id
|
|
|
|
* @param integer $page_id
|
|
|
|
* @param integer $newVersion
|
|
|
|
* @param string $title
|
|
|
|
* @param string $content
|
|
|
|
*/
|
2015-05-22 14:48:09 +02:00
|
|
|
public function updatePage($parent_id, $page_id, $newVersion, $title, $content)
|
|
|
|
{
|
2015-05-21 17:39:11 +02:00
|
|
|
$body = [
|
|
|
|
'type' => 'page',
|
|
|
|
'space' => ['key' => $this->space],
|
|
|
|
'ancestors' => [['type' => 'page', 'id' => $parent_id]],
|
|
|
|
'version' => ['number' => $newVersion, "minorEdit" => false],
|
|
|
|
'title' => $title,
|
|
|
|
'body' => ['storage' => ['value' => $content, 'representation' => 'storage']]
|
|
|
|
];
|
|
|
|
|
2015-05-22 14:48:09 +02:00
|
|
|
try {
|
|
|
|
$this->getClient()->put("content/$page_id", ['json' => $body])->json();
|
|
|
|
} catch (BadResponseException $e) {
|
|
|
|
throw $this->handleError($e);
|
|
|
|
}
|
2015-05-21 17:39:11 +02:00
|
|
|
}
|
|
|
|
|
2015-07-17 23:38:06 +02:00
|
|
|
/**
|
|
|
|
* Delete a page
|
|
|
|
*
|
|
|
|
* @param integer $page_id
|
|
|
|
* @return mixed
|
|
|
|
*/
|
2015-05-22 14:48:09 +02:00
|
|
|
public function deletePage($page_id)
|
|
|
|
{
|
|
|
|
try {
|
|
|
|
return $this->getClient()->delete('content/' . $page_id)->json();
|
|
|
|
} catch (BadResponseException $e) {
|
|
|
|
throw $this->handleError($e);
|
|
|
|
}
|
2015-05-21 17:39:11 +02:00
|
|
|
}
|
|
|
|
|
2015-07-17 23:38:06 +02:00
|
|
|
/**
|
|
|
|
* @param integer $id
|
|
|
|
* @param array $attachment
|
|
|
|
*/
|
2015-05-22 14:48:09 +02:00
|
|
|
public function uploadAttachment($id, $attachment)
|
|
|
|
{
|
2015-08-02 15:42:23 +02:00
|
|
|
// Check if an attachment with
|
|
|
|
// this name is uploaded
|
2015-05-22 14:48:09 +02:00
|
|
|
try {
|
|
|
|
$result = $this->getClient()->get("content/$id/child/attachment?filename=$attachment[filename]")->json();
|
|
|
|
} catch (BadResponseException $e) {
|
|
|
|
throw $this->handleError($e);
|
|
|
|
}
|
2015-05-21 17:39:11 +02:00
|
|
|
|
2015-08-02 15:42:23 +02:00
|
|
|
$url = "content/$id/child/attachment";
|
|
|
|
|
|
|
|
// If the attachment is already uploaded,
|
|
|
|
// the update URL is different
|
|
|
|
if (count($result['results'])) {
|
|
|
|
$url .= "/{$result['results'][0]['id']}/data";
|
|
|
|
}
|
2015-05-22 14:48:09 +02:00
|
|
|
|
|
|
|
try {
|
|
|
|
$this->getClient()->post(
|
|
|
|
$url,
|
|
|
|
[
|
2015-07-17 23:38:06 +02:00
|
|
|
'body' => ['file' => fopen($attachment['file']->getPath(), 'r')],
|
2015-05-22 14:48:09 +02:00
|
|
|
'headers' => ['X-Atlassian-Token' => 'nocheck'],
|
|
|
|
]
|
|
|
|
);
|
|
|
|
} catch (BadResponseException $e) {
|
|
|
|
throw $this->handleError($e);
|
|
|
|
}
|
2015-05-21 17:39:11 +02:00
|
|
|
}
|
|
|
|
}
|