bludit/bl-plugins/api/plugin.php

330 lines
7.9 KiB
PHP
Raw Normal View History

2016-05-29 19:21:11 +02:00
<?php
class pluginAPI extends Plugin {
public function init()
{
// Generate the API Token
$token = md5( uniqid().time().DOMAIN );
$this->dbFields = array(
2016-12-01 02:39:16 +01:00
'ping'=>0, // 0 = false, 1 = true
'token'=>$token, // API Token
2016-12-01 02:39:16 +01:00
'showAllAmount'=>15, // Amount of posts and pages for return
'authentication'=>1 // Authentication required
);
}
public function form()
{
2016-06-03 03:37:52 +02:00
$html = '';
$html .= '<div>';
2016-12-01 02:39:16 +01:00
$html .= '<p><b>Authorization Key:</b> '.$this->getDbField('token').'</p>';
$html .= '<div class="tip">This key is private, do not share it with anyone.</div>';
$html .= '</div>';
$html .= '<div>';
2016-12-01 02:39:16 +01:00
$html .= '<p><b>Show all posts:</b> <a href="'.DOMAIN_BASE.'api/show/all/posts/'.$this->getDbField('token').'">'.DOMAIN_BASE.'api/show/all/posts/'.$this->getDbField('token').'</a></p>';
$html .= '<div class="tip">Get all posts from this site.</div>';
$html .= '</div>';
$html .= '<div>';
2016-12-01 02:39:16 +01:00
$html .= '<p><b>Show all pages:</b> <a href="'.DOMAIN_BASE.'api/show/all/pages/'.$this->getDbField('token').'">'.DOMAIN_BASE.'api/show/all/pages/'.$this->getDbField('token').'</a></p>';
$html .= '<div class="tip">Get all pages from this site.</div>';
$html .= '</div>';
$html .= '<div>';
$html .= '<p><b>Show post:</b> <a href="'.DOMAIN_BASE.'api/show/post/{POST-NAME}">'.DOMAIN_BASE.'api/show/post/{POST-NAME}</a></p>';
$html .= '<div class="tip">Get a particular post, change the {POST-NAME} with the post friendly url.</div>';
$html .= '</div>';
$html .= '<div>';
$html .= '<p><b>Show page:</b> <a href="'.DOMAIN_BASE.'api/show/page/{PAGE-NAME}">'.DOMAIN_BASE.'api/show/page/{PAGE-NAME}</a></p>';
$html .= '<div class="tip">Get a particular page, change the {PAGE-NAME} with the page friendly url.</div>';
$html .= '</div>';
2016-06-03 03:37:52 +02:00
return $html;
}
2016-12-01 02:39:16 +01:00
// API HOOKS
// ----------------------------------------------------------------------------
public function beforeRulesLoad()
2016-09-25 20:38:15 +02:00
{
2016-12-01 02:39:16 +01:00
global $Url;
2016-12-02 00:59:58 +01:00
global $dbPages;
global $dbUsers;
2016-09-25 20:38:15 +02:00
// CHECK URL
// ------------------------------------------------------------
2016-12-01 02:39:16 +01:00
// Check if the URI start with /api/
$startString = HTML_PATH_ROOT.'api/';
$URI = $Url->uri();
$length = mb_strlen($startString, CHARSET);
if( mb_substr($URI, 0, $length)!=$startString ) {
return false;
}
// Remove the first part of the URI
$URI = mb_substr($URI, $length);
// INPUTS
2016-12-01 02:39:16 +01:00
// ------------------------------------------------------------
$inputs = $this->getInputs();
2016-12-01 02:39:16 +01:00
// PARAMETERS
2016-12-01 02:39:16 +01:00
// ------------------------------------------------------------
$parameters = $this->getParameters($URI);
2016-12-01 02:39:16 +01:00
// API TOKEN
// ------------------------------------------------------------
$tokenAPI = $this->getValue('token');
2016-12-01 02:39:16 +01:00
// Check empty token
if( empty($inputs['token']) ) {
$this->response(array(
'status'=>'1',
'message'=>'Missing API token.'
));
2016-12-01 02:39:16 +01:00
}
// Check the token is valid
if( $inputs['token']!=$tokenAPI ) {
$this->response(array(
'status'=>'1',
'message'=>'Invalid API token.'
));
2016-12-01 02:39:16 +01:00
}
// AUTHENTICATION TOKEN
2016-12-01 02:39:16 +01:00
// ------------------------------------------------------------
$writePermissions = false;
if( !empty($inputs['authentication']) ) {
// Get the user with the authentication token
$username = $dbUsers->getByAuthToken($inputs['authentication']);
if( $username!==false ) {
// Enable write permissions
$writePermissions = true;
2016-12-01 02:39:16 +01:00
}
}
// /api/posts
if( ($method==='GET') && ($parameters[0]==='posts') && empty($parameters[1]) ) {
2016-12-01 19:09:29 +01:00
$data = $this->getAllPosts();
$this->response($data);
2016-12-01 02:39:16 +01:00
}
// /api/pages
elseif( ($method==='GET') && ($parameters[0]==='pages') && empty($parameters[1]) ) {
2016-12-01 19:09:29 +01:00
$data = $this->getAllPages();
$this->response($data);
2016-12-01 02:39:16 +01:00
}
2017-04-26 18:56:10 +02:00
// /api/posts/{key}
2016-12-01 02:39:16 +01:00
elseif( ($method==='GET') && ($parameters[0]==='posts') && !empty($parameters[1]) ) {
2016-12-01 19:09:29 +01:00
$data = $this->getPost($parameters[1]);
$this->response($data);
2016-12-01 02:39:16 +01:00
}
2017-04-26 18:56:10 +02:00
// /api/pages/{key}
2016-12-01 02:39:16 +01:00
elseif( ($method==='GET') && ($parameters[0]==='pages') && !empty($parameters[1]) ) {
2016-12-01 19:09:29 +01:00
$data = $this->getPage($parameters[1]);
$this->response($data);
2016-12-01 02:39:16 +01:00
}
2016-12-02 00:59:58 +01:00
// /api/cli/regenerate
elseif( ($method==='POST') && ($parameters[0]==='cli') && ($parameters[1]==='regenerate') ) {
// Regenerate posts
if( $dbPosts->cliMode() ) {
reIndexTagsPosts();
}
2016-12-01 02:39:16 +01:00
2016-12-02 00:59:58 +01:00
// Regenerate pages
$dbPages->cliMode();
$this->response(array(
'status'=>'0',
'message'=>'Pages and post regenerated.'
));
}
2016-09-25 20:38:15 +02:00
}
// PRIVATE METHODS
2016-12-01 02:39:16 +01:00
// ----------------------------------------------------------------------------
private function getParameters($URI)
{
// PARAMETERS
// ------------------------------------------------------------
// /api/pages | GET | returns all pages
// /api/pages/{key} | GET | returns the page with the {key}
// /api/cli/regenerate | POST | check for new posts and pages
$parameters = explode('/', $URI);
// Sanitize parameters
foreach($parameters as $key=>$value) {
$parameters[$key] = Sanitize::html($value);
}
return $parameters;
}
private function getInputs()
{
// METHODS
// ------------------------------------------------------------
// GET
// POST
// PUT
// DELETE
$method = $_SERVER['REQUEST_METHOD'];
switch($method) {
case "POST":
$inputs = $_POST;
break;
case "GET":
case "DELETE":
$inputs = $_GET;
break;
case "PUT":
$inputs = file_get_contents("php://input");
break;
default:
$inputs = json_encode(array());
break;
}
// Input data need to be JSON
$inputs = json_decode(file_get_contents('php://input'),true);
// Sanitize inputs
foreach($inputs as $key=>$value) {
$inputs[$key] = Sanitize::html($value);
}
return $inputs;
}
2016-12-01 19:09:29 +01:00
private function response($data=array())
{
$json = json_encode($data);
header('Content-Type: application/json');
exit($json);
}
private function ping()
{
if($this->getDbField('ping')) {
// Get the authentication key
2016-12-01 02:39:16 +01:00
$token = $this->getDbField('token');
2016-12-01 02:39:16 +01:00
$url = 'https://api.bludit.com/ping?token='.$token.'&url='.DOMAIN_BASE;
2016-09-24 18:24:56 +02:00
// Check if curl is installed
if( function_exists('curl_version') ) {
2016-09-25 20:20:03 +02:00
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
2016-09-24 18:24:56 +02:00
$out = curl_exec($ch);
2016-09-25 20:20:03 +02:00
if($out === false) {
Log::set('Plugin API : '.'Curl error: '.curl_error($ch));
2016-09-24 18:24:56 +02:00
}
curl_close($ch);
}
2016-09-25 20:20:03 +02:00
else {
$options = array(
"ssl"=>array(
"verify_peer"=>false,
"verify_peer_name"=>false
)
);
$stream = stream_context_create($options);
$out = file_get_contents($url, false, $stream);
}
}
}
private function getPost($key)
2016-05-29 19:21:11 +02:00
{
// Generate the object Post
$Post = buildPost($key);
if(!$Post) {
2016-12-01 19:09:29 +01:00
return array(
'status'=>'1',
'message'=>'Post not found.'
);
2016-05-29 19:21:11 +02:00
}
2016-12-01 19:09:29 +01:00
$data['status'] = '0';
$data['message'] = '';
2016-12-02 00:59:58 +01:00
$data['data'] = $Post->json( $returnsArray=true );
2016-12-01 19:09:29 +01:00
2016-12-02 00:59:58 +01:00
return $data;
2016-05-29 19:21:11 +02:00
}
private function getAllPosts()
{
$posts = buildPostsForPage(0, $this->getDbField('showAllAmount'), true, false);
2016-12-01 19:09:29 +01:00
$tmp = array(
'status'=>'0',
2016-12-02 00:59:58 +01:00
'message'=>'',
'data'=>array()
2016-12-01 19:09:29 +01:00
);
foreach($posts as $Post) {
2016-12-02 00:59:58 +01:00
array_push($tmp['data'], $Post->json( $returnsArray=true ));
}
2016-12-01 19:09:29 +01:00
return $tmp;
}
private function getPage($key)
2016-05-29 19:21:11 +02:00
{
// Generate the object Page
$Page = buildPage($key);
if(!$Page) {
2016-12-01 19:09:29 +01:00
return array(
'status'=>'1',
'message'=>'Page not found.'
);
2016-05-29 19:21:11 +02:00
}
2016-12-01 19:09:29 +01:00
$data['status'] = '0';
$data['message'] = '';
2016-12-02 00:59:58 +01:00
$data['data'] = $Page->json( $returnsArray=true );
2016-12-01 19:09:29 +01:00
return $data;
2016-05-29 19:21:11 +02:00
}
2016-06-06 04:24:15 +02:00
private function getAllPages()
{
$pages = buildAllPages();
2016-12-01 19:09:29 +01:00
$tmp = array(
'status'=>'0',
2016-12-02 00:59:58 +01:00
'message'=>'',
'data'=>array()
2016-12-01 19:09:29 +01:00
);
2016-06-06 04:24:15 +02:00
foreach($pages as $Page) {
if($Page->published()) {
2016-12-02 00:59:58 +01:00
array_push($tmp['data'], $Page->json( $returnsArray=true ));
2016-06-06 04:24:15 +02:00
}
}
2016-12-01 19:09:29 +01:00
return $tmp;
2016-06-06 04:24:15 +02:00
}
2016-12-02 00:59:58 +01:00
}