Atom feed

This commit is contained in:
mmk2410 2016-02-16 14:19:17 +01:00
parent 5d041ff6f8
commit ce709fec80
7 changed files with 240 additions and 33 deletions

View file

@ -1,6 +1,6 @@
<?php
/**
* PHP Version 5.6
* PHP Version 7
*
* Rangitaki Project
* This is the configuration file. You can configure here all necessary
@ -82,3 +82,6 @@ $pagination = 0;
// Favicon - Set here the path to your favicon
$favicon = "http://example.com/res/img/favicon.png";
// Blog url - set here the blog url
$blogurl = "https://example.com/blog/";

14
feed/.atom Normal file
View file

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<generator uri="https://github.com/fguillot/picoFeed">PicoFeed</generator>
<title>Example Blog</title>
<id>https://marcel-kapfer.de/rangitaki/blog/</id>
<updated>2016-02-16T10:52:47+00:00</updated>
<link rel="alternate" type="text/html" href="https://marcel-kapfer.de/rangitaki/blog/"/>
<link rel="self" type="application/atom+xml" href="https://marcel-kapfer.de/rangitaki/blog//feed/feed.atom"/>
<author>
<name>John</name>
<email></email>
<uri>https://marcel-kapfer.de/rangitaki/blog/</uri>
</author>
</feed>

View file

@ -26,11 +26,13 @@ MIT License
*/
// Getting necessary php files
date_default_timezone_set('UTC');
require __DIR__ . '/vendor/autoload.php'; // loading composer libs
require 'config.php'; // Config file (this must be the first line)
require './lang/' . $language . ".php"; // Language file
require_once 'res/php/Parsedown.php'; // The soul of the beast: Parsedown
require_once 'res/php/ArticleGenerator.php'; // The article generator
require_once './res/php/BlogListGenerator.php'; // and the blog list generator
// Getting some variables ($_GET and $_SERVER)
$getblog = filter_input(INPUT_GET, "blog"); // get the blog variable
$getarticle = filter_input(INPUT_GET, "article"); // get the article variable
@ -86,11 +88,15 @@ if (isset($getarticle)) {
} else {
$hd_subblog_title = $subblogtitle;
}
// url of the feed
$feedurl = $blogurl . "/feed/" . $blog . ".atom";
?>
<head>
<meta charset="utf-8">
<title><?php echo $hd_subblog_title; ?></title>
<title><?php echo $blogtitle . " » " .$hd_subblog_title; ?></title>
<!--Metatags-->
<meta name="author"
content="<?php echo $blogauthor; // Set the blog author ?>"/>
@ -114,6 +120,17 @@ if (isset($getarticle)) {
<meta name="twitter:description" content="<?php echo $blogdescription; ?>"/>
<meta name="twitter:image" content="<?php echo $favicon; ?>"/>
<meta name="twitter:url" content="<?php echo $url; ?>"/>
<!-- atom feed -->
<?php
if (file_exists("feed/" . $blog . ".atom")) {
?>
<link rel='alternate' type='application/atom+xml' title='Atom 0.3' href=
'<?php
echo $feedurl;
?>'>
<?php
}
?>
<!--CSS files-->
<link rel="stylesheet" type="text/css" href="res/css/rangitaki.css"/>
<!-- stylesheet for code highlighting-->
@ -206,6 +223,13 @@ if ($nav_drawer == "yes") {
</a>
<?php
}
if (file_exists("feed/" . $blog . ".atom")) { ?>
<div class="divider"></div>
<a class="nav-item" href=
'<?php
echo $feedurl;
?>'>Feed</a><?php
}
?>
</div> <!-- End of the navigation drawer-->
<?php

98
rcc/feed/index.php Normal file
View file

@ -0,0 +1,98 @@
<?php
/**
* PHP Version 7
*
* @category Atom_Feed
* @package Rbe
* @author Marcel Kapfer (mmk2410) <marcelmichaelkapfer@yahoo.co.nz>
* @license MIT License
* @link https://github.com/mmk2410/rangitaki
*
* The MIT License
*
* Copyright 2015 mmk2410.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
date_default_timezone_set('UTC');
require "../../vendor/autoload.php";
require_once "../../config.php";
require_once "../../res/php/ArticleGenerator.php";
use PicoFeed\Syndication\Atom;
session_start();
if ($_SESSION['login']) {
$art_dir = "./../../articles/" . $_GET['blog'] . "/";
$feed_path = "./../../feed/" . $_GET['blog'] . ".atom";
$writer = new Atom();
$writer->title = $blogtitle;
$writer->site_url = $blogurl;
$writer->feed_url = $blogurl . "/feed/feed.atom";
$writer->author = array(
'name' => $blogauthor,
'url' => $blogurl,
'email' => ''
);
$articles = scandir($art_dir, 1);
$amount = 0;
foreach ($articles as $article) {
if (strlen($article) >= 3 && substr($article, -3) == ".md") {
if ($amount == 10) {
break;
} else {
$writer->items[] = array(
'title' => ArticleGenerator::getTitle($art_dir, $article),
'updated' => strtotime(
ArticleGenerator::getDate($art_dir . $article)
),
'url' => $blogurl . "./?article=" .
substr($article, 0, strlen($article) - 3),
'summary'=> ArticleGenerator::getSummary(
$art_dir, $articles
),
'content' => "<p>" . ArticleGenerator::getText(
$art_dir, $articles
) . "</p>"
);
$amount += 1;
}
}
}
$feed = $writer->execute();
$file = fopen($feed_path, "w");
if (fwrite($file, $feed) === false) {
echo "-1";
exit;
}
fclose($file);
echo "0";
}
?>

View file

@ -1,30 +1,14 @@
<!DOCTYPE html>
<!--
The MIT License
Copyright 2015 mmk2410.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<html>
<head>
<meta charset="UTF-8">
<!--
Rangitaki Blogging Engine - RCC (Rangitaki Control Center)
Copyright (c) 2016 by Marcel Kapfer (mmk2410)
MIT License
-->
<title>Rangitaki Control Center</title>
<meta content='width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0' name='viewport'/>
<link rel="stylesheet" href="./res/rcc.css"/>
@ -164,6 +148,23 @@ THE SOFTWARE.
<input id="button" type="submit" value="Upload" class="button"/>
</form>
</section>
<section class="card">
<div class="headline">Atom Feed Generator</div>
<p>
<select name="blog" id="generate_atom_blog">
<?php
$blogs = scandir("../blogs/");
foreach ($blogs as $blog) {
if (strlen($blog) >= 3 && substr($blog, -3) == ".md") {
$blog = substr($blog, 0, -3);
echo "<option value='$blog'>$blog</option>";
}
}
?>
</select>
</p>
<a class="button" id="generate_atom">GENERATE</a>
</section>
<?php
} else {
?>
@ -182,8 +183,8 @@ THE SOFTWARE.
<section class="card">
<div class="headline">Rangitaki Control Center</div>
<p>
The Rangitaki Control Center is disabled. You can enable it in your config file. But please read first
the documentation.
The Rangitaki Control Center is disabled. You can enable it in
your config file. But please read first the documentation.
</p>
</section>
<?php
@ -201,5 +202,6 @@ THE SOFTWARE.
<script src="../res/js/jquery-2.1.4.min.js"></script>
<script src="./res/delete.js"></script>
<script src="./res/edit.js"></script>
<script src="./res/atom.js"></script>
</body>
</html>

28
rcc/res/atom.js Normal file
View file

@ -0,0 +1,28 @@
/**
* Created by mmk2410 on 2016-02-16.
*
* JavaScript for the ajax request to generate a atom feed
*
* Copyright (c) 2016 by mmk2410
* License: MIT License
*/
function main() {
// listener and function for calling the ajax request to create the
// requested atom feed
$("#generate_atom").click(function () {
var selectedBlog = $("#generate_atom_blog").val();
$.get("feed/index.php", {
blog: selectedBlog
}, function (data) {
if (data == "0") {
alert("Atom feed sucessfully created.");
} else {
alert("Failed to create atom feed.");
}
});
});
}
$(document).ready(main());

View file

@ -1,5 +1,15 @@
<?php
/*
/**
* PHP Version 7
*
* Since there is no initialize function, I recommend to use the short access syntay
*
* @category Articles
* @package RangitakiPHP
* @author mmk2410 <marcelmichaelkapfer@yahoo.co.nz>
* @license MIT License
* @link http://marcel-kapfer.de/rangitaki
*
* Rangitaki Project
*
* The MIT License
@ -26,7 +36,8 @@
*/
/**
* The article generator class is a collection of functions for generating the article of markdown
* The article generator class is a collection of functions for generating the
* article of markdown
*
* Since there is no initialize function, I recommend to use the short access syntay
*
@ -45,6 +56,8 @@ class ArticleGenerator
* @param string $directory The directory where the article files are stored
* @param string $articlefile The name of the article file
* @param string $blog The name of the current blog
*
* @return Null
*/
function newArticle($directory, $articlefile, $blog)
{
@ -172,6 +185,31 @@ class ArticleGenerator
}
}
/**
* A function to get a short summary of a text
*
* @param $directory The directory where the article is stored
* @param $articlefile The name of the article file
*
* @return string
*/
static function getSummary($directory, $articlefile)
{
$text = getText($directory, $articlefile);
$pos = stripos($text, ".");
if ($pos) {
$offset = $pos + 1;
$pos = stripos($text, ".", $offset);
$summary = substr($text, 0, $pos) . ".";
return $summary;
} else {
return $text;
}
}
/**
* A function to get the author of an article
*