'Requesting unsupported format, only JSON or RSS is allowed',
self::ERROR_PAGE_NOT_FOUND => 'Page not found',
self::ERROR_MISSING_LIST_REFERENCE => 'This page has no custom field referring to an Arlima article list',
self::ERROR_LIST_DOES_NOT_EXIST => 'Custom field "arlima" on current page is referring to an article list that does not exist',
self::ERROR_LIST_BLOCKED_FROM_EXPORT => 'This list is not available for export'
);
/**
* @var array
*/
private $available_export;
/**
* @var Arlima_Plugin
*/
private $arlima_plugin;
/**
* @param Arlima_Plugin $arlima_plugin
*/
public function __construct($arlima_plugin) {
$settings = $arlima_plugin->loadSettings();
$this->available_export = !empty($settings['available_export']) ? $settings['available_export']:array();
$this->arlima_plugin = $arlima_plugin;
}
/**
* This function provides a small read-only RESTful API. It sends out appropriate response headers
* depending on the request being made. It support two response content types, RSS and JSON
*
* @param string $page_slug
* @param string $format
* @throws Exception
*/
public function export($page_slug, $format) {
$this->sendInitialHeaders($format);
if(!in_array($format, array(self::FORMAT_JSON, self::FORMAT_RSS))) {
$this->sendErrorToClient(self::ERROR_UNSUPPORTED_FORMAT, '400 Bad Request', self::DEFAULT_FORMAT);
}
$page = !$page_slug ? get_page(get_option('page_on_front', 0)) : get_page_by_title(str_replace('-', ' ', $page_slug));
if(!$page) {
$this->sendErrorToClient(self::ERROR_PAGE_NOT_FOUND, '404 Page Not Found', $format);
}
else {
$arlima_slug = get_post_meta($page->ID, 'arlima', true);
if(!$arlima_slug) {
$this->sendErrorToClient(self::ERROR_MISSING_LIST_REFERENCE, '400 Bad Request', $format);
}
$list = Arlima_ListFactory::loadList($arlima_slug);
if(!$list->exists) {
$this->sendErrorToClient(self::ERROR_LIST_DOES_NOT_EXIST, '500 Internal Server Error', $format);
}
elseif(!$this->isAvailableForExport($list)) {
$this->sendErrorToClient(self::ERROR_LIST_BLOCKED_FROM_EXPORT, '403 Forbidden', $format);
}
else {
echo $this->convertList($list, $format);
}
}
die(0);
}
/**
* @param $format
*/
private function sendInitialHeaders($format) {
header_remove();
switch($format) {
case self::FORMAT_RSS:
header('Content-Type: text/xml; charset=utf8');
break;
default:
header('Content-Type: application/json');
break;
}
}
/**
* @param int $error_code
* @param string $http_status
* @param string $format
*/
private function sendErrorToClient($error_code, $http_status, $format) {
header('HTTP/1.1 '.$http_status);
$message = isset($this->error_messages[$error_code]) ? $this->error_messages[$error_code] : 'Unknown error';
switch($format) {
case self::FORMAT_RSS:
echo ''.$message.''.$error_code.'';
break;
default:
echo '{"error":"'.$message.'","code":'.$error_code.'}';
break;
}
die;
}
/**
* @param Arlima_List $list
* @param string $format
* @return string
*/
private function convertList($list, $format) {
// Modify data exported
$base_url = rtrim(home_url(), '/').'/';
foreach(array_keys($list->articles) as $key) {
$this->prepareArticleForExport($list->articles[$key], $base_url);
}
// RSS export
if($format == self::FORMAT_RSS) {
$base_url = get_bloginfo('url');
$rss = '
<![CDATA['.$list->title.' ('.$list->slug.')]]>
RSS export feed for Arlima article list
'.$base_url.'
'.date('r', time()).'
'.date('r', $list->lastModified()).'
1
Arlima v'.Arlima_Plugin::VERSION.' (wordpress plugin)
';
$list_last_mod_time = $list->lastModified();
foreach($list->articles as $article) {
$rss .= $this->articleToRSSItem($article, $list_last_mod_time);
if( !empty($article['children']) ) {
foreach($article['children'] as $child_article)
$rss .= $this->articleToRSSItem($child_article, $list_last_mod_time);
}
}
return $rss.'';
}
// JSON export
else {
return json_encode( (array)$list );
}
}
/**
* - Move all ID numbers from key "xxx_id" to "external_xxx_id"
* - Make sure all URL:s starts with a base url
*
* @param array &$article_data
* @param string $base_url
* @return array
*/
private function prepareArticleForExport(&$article_data, $base_url) {
if(substr($article_data['url'], 0, 7) != 'http://') {
$article_data['url'] = $base_url . ltrim($article_data['url'],'/');
}
$article_data['external_post_id'] = 0;
if( !empty($article_data['post_id']) ) {
$article_data['external_post_id'] = $article_data['post_id'];
$article_data['post_id'] = 0;
}
if( !empty($article_data['image_options']) ) {
$article_data['image_options']['external_attach_id'] = isset($article_data['image_options']['attach_id']) ? $article_data['image_options']['attach_id']:0;
$article_data['image_options']['attach_id'] = 0;
}
if( !empty($article_data['children']) ) {
foreach(array_keys($article_data['children']) as $key)
$this->prepareArticleForExport($article_data['children'][$key], $base_url);
}
}
/**
* @param array $article
* @param int $last_mod
* @return string
*/
private function articleToRSSItem(array $article, $last_mod) {
$img = '';
if(isset($article['image_options']) && !empty($article['image_options']['url']))
$img = '';
$guid = $article['url'];
$post_id = intval($article['external_post_id']);
if($post_id) {
$guid = '/?p='.$post_id;
$date = date('r', strtotime(get_post($post_id)->post_date));
}
else {
$date = date('r', $last_mod);
}
return '-
<![CDATA['.$article['title'].']]>
'.$article['url'].'
'.$guid.'
'.$date.'
'.$img.'
';
}
/**
* @return array
*/
public function getListsAvailableForExport() {
return $this->available_export;
}
/**
* @param array $lists
*/
public function setListsAvailableForExport(array $lists) {
$this->available_export = $lists;
$settings = $this->arlima_plugin->loadSettings();
$settings['available_export'] = $lists;
$this->arlima_plugin->saveSettings($settings);
}
/**
* @param Arlima_List|int $list
* @return bool
*/
public function isAvailableForExport($list) {
$id = is_object($list) ? $list->id : $list;
return in_array($id, $this->available_export);
}
}