dokuwiki/dokuwiki-plugin-semantic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'develop'

Browse source
This commit is contained in:
Giuseppe Di Terlizzi 2023-02-03 00:04:17 +01:00
commit a97af226e4
7 changed files with 63 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.travis.yml
View file

@ -8,10 +8,6 @@ php:
env:
- DOKUWIKI=master
- DOKUWIKI=stable
matrix:
include:
- php: "5.6"
env: DOKUWIKI=old-stable
before_install: wget https://raw.github.com/splitbrain/dokuwiki-travis/master/travis.sh
install: sh travis.sh
script: cd _test && ./phpunit.phar --stderr --group plugin_semantic
script: cd _test && ./phpunit.phar --stderr --group plugin_semantic

9
_test/general.test.php
View file

@ -6,13 +6,15 @@
* @group plugin_semantic
* @group plugins
*/
class general_plugin_semantic_test extends DokuWikiTest {
class general_plugin_semantic_test extends DokuWikiTest
{
/**
* Simple test to make sure the plugin.info.txt is in correct format
*/
public function test_plugininfo() {
$file = __DIR__.'/../plugin.info.txt';
public function test_plugininfo()
{
$file = __DIR__ . '/../plugin.info.txt';
$this->assertFileExists($file);
$info = confToHash($file);
@ -32,4 +34,3 @@ class general_plugin_semantic_test extends DokuWikiTest {
$this->assertTrue(false !== strtotime($info['date']));
}
}

10
action.php
View file

@ -4,13 +4,9 @@
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Giuseppe Di Terlizzi <giuseppe.diterlizzi@gmail.com>
* @copyright (C) 2015-2019, Giuseppe Di Terlizzi
* @copyright (C) 2015-2023, Giuseppe Di Terlizzi
*/
// must be run within Dokuwiki
if (!defined('DOKU_INC')) {
die();
}
/**
* Class Semantic Action Plugin
@ -108,10 +104,8 @@ class action_plugin_semantic extends DokuWiki_Action_Plugin
$this->helper->getMetadata($id);
$json_ld = $this->helper->getJsonLD();
$json = new JSON();
header('Content-Type: application/ld+json');
print $json->encode($json_ld);
print json_encode($json_ld);
return true;
}

2
conf/default.php
View file

@ -12,5 +12,5 @@ $conf['useMetaDescription'] = 1;
$conf['useMetaAuthor'] = 1;
$conf['useDublinCore'] = 0;
$conf['useOpenGraph'] = 0;
$conf['excludedPages'] = '(wiki|playground)';
$conf['excludedPages'] = '(wiki)';
$conf['hideMail'] = 0;

2
conf/metadata.php
View file

@ -11,6 +11,6 @@ $meta['useDublinCore'] = array('onoff');
$meta['useOpenGraph'] = array('onoff');
$meta['useJSONLD'] = array('onoff');
$meta['exposeWebService'] = array('onoff');
$meta['defaultSchemaOrgType'] = array('multichoice','_choices' => array('Article', 'NewsArticle', 'TechArticle', 'BlogPosting', 'Recipe'));
$meta['defaultSchemaOrgType'] = array('multichoice', '_choices' => array('Article', 'NewsArticle', 'TechArticle', 'BlogPosting', 'Recipe'));
$meta['excludedPages'] = array('regex');
$meta['hideMail'] = array('onoff');

30
helper.php
View file

@ -4,14 +4,9 @@
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Giuseppe Di Terlizzi <giuseppe.diterlizzi@gmail.com>
* @copyright (C) 2015-2019, Giuseppe Di Terlizzi
* @copyright (C) 2015-2022, Giuseppe Di Terlizzi
*/
// must be run within Dokuwiki
if (!defined('DOKU_INC')) {
die();
}
class helper_plugin_semantic extends DokuWiki_Plugin
{
@ -29,7 +24,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
global $conf;
$json_ld = array(
'@context' => 'http://schema.org',
'@context' => 'http://schema.org/',
'@type' => 'WebSite',
'url' => DOKU_URL,
'name' => $conf['title'],
@ -106,7 +101,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
*/
public function getFirstImage()
{
return ((@$this->meta['relation']['firstimage']) ? $this->meta['relation']['firstimage'] : null);
return (isset($this->meta['relation']['firstimage']) ? $this->meta['relation']['firstimage'] : null);
}
/**
@ -126,7 +121,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
*/
public function getDescription()
{
return (@$this->meta['description']['abstract'] ? $this->meta['description']['abstract'] : $this->getTitle());
return (isset($this->meta['description']['abstract']) ? $this->meta['description']['abstract'] : $this->getTitle());
}
/**
@ -156,7 +151,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
*/
public function getTitle()
{
return (@$this->meta['title'] ? $this->meta['title'] : null);
return (isset($this->meta['title']) ? $this->meta['title'] : null);
}
/**
@ -166,7 +161,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
*/
public function getCreatedDate()
{
return ((@$this->meta['date']['created']) ? $this->meta['date']['created'] : -1);
return (isset($this->meta['date']['created']) ? $this->meta['date']['created'] : -1);
}
/**
@ -176,7 +171,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
*/
public function getModifiedDate()
{
return ((@$this->meta['date']['modified']) ? $this->meta['date']['modified'] : -1);
return (isset($this->meta['date']['modified']) ? $this->meta['date']['modified'] : -1);
}
/**
@ -188,7 +183,8 @@ class helper_plugin_semantic extends DokuWiki_Plugin
{
global $license;
global $conf;
return @$license[$conf['license']];
return (isset($license[$conf['license']]) ? $license[$conf['license']] : null);
}
/**
@ -219,7 +215,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
$wiki_logo = tpl_getMediaFile(array(':wiki:logo.png', ':logo.png', 'images/logo.png'), true, $wiki_logo_info);
$json_ld = array(
'@context' => 'http://schema.org',
'@context' => 'http://schema.org/',
'@type' => $type,
'headline' => $title,
'name' => $title,
@ -268,7 +264,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
if ($author = $this->getAuthor()) {
$json_ld['author'] = array(
'@context' => 'http://schema.org',
'@context' => 'http://schema.org/',
'@type' => 'Person',
'name' => $author,
'email' => $user_data['mail'],
@ -280,7 +276,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
$contributor_data = ($this->getConf('hideMail') ? array('mail' => null) : $auth->getUserData($uid));
$json_ld['contributor'][] = array(
'@context' => 'http://schema.org',
'@context' => 'http://schema.org/',
'@type' => 'Person',
'name' => $fullname,
'email' => $contributor_data['mail'],
@ -319,7 +315,7 @@ class helper_plugin_semantic extends DokuWiki_Plugin
}
$json_ld_webpage = array(
'@context' => 'http://schema.org',
'@context' => 'http://schema.org/',
'@type' => 'WebPage',
);

77
syntax.php
View file

@ -1,54 +1,57 @@
<?php
/**
* Semantic plugin: Add Schema.org News Article using JSON-LD
*
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Giuseppe Di Terlizzi <giuseppe.diterlizzi@gmail.com>
* @copyright (C) 2015-2023, Giuseppe Di Terlizzi
*/
// must be run within Dokuwiki
if (!defined('DOKU_INC')) die();
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
class syntax_plugin_semantic extends DokuWiki_Syntax_Plugin
{
class syntax_plugin_semantic extends DokuWiki_Syntax_Plugin {
private $macros = array(
'~~NewsArticle~~', '~~Article~~', '~~TechArticle~~',
'~~BlogPosting~~', '~~Recipe~~', '~~NOSEMANTIC~~',
);
private $macros = array(
'~~NewsArticle~~', '~~Article~~', '~~TechArticle~~',
'~~BlogPosting~~', '~~Recipe~~', '~~NOSEMANTIC~~'
);
public function getType()
{return 'substition';}
public function getSort()
{return 99;}
function getType() { return 'substition'; }
function getSort() { return 99; }
public function connectTo($mode)
{
function connectTo($mode) {
foreach ($this->macros as $macro) {
$this->Lexer->addSpecialPattern($macro, $mode, 'plugin_semantic');
}
}
function handle($match, $state, $pos, Doku_Handler $handler) {
return array($match, $state, $pos);
}
function render($mode, Doku_Renderer $renderer, $data) {
if ($mode == 'metadata') {
list($match, $state, $pos) = $data;
if ($match == '~~NOSEMANTIC~~') {
$renderer->meta['plugin']['semantic']['enabled'] = false;
} else {
$renderer->meta['plugin']['semantic']['schema.org']['type'] = trim(str_replace('Schema.org/', '', $match), '~~');
$renderer->meta['plugin']['semantic']['enabled'] = true;
}
foreach ($this->macros as $macro) {
$this->Lexer->addSpecialPattern($macro, $mode, 'plugin_semantic');
}
}
return false;
public function handle($match, $state, $pos, Doku_Handler $handler)
{
return array($match, $state, $pos);
}
}
public function render($mode, Doku_Renderer $renderer, $data)
{
if ($mode == 'metadata') {
list($match, $state, $pos) = $data;
if ($match == '~~NOSEMANTIC~~') {
$renderer->meta['plugin']['semantic']['enabled'] = false;
} else {
$renderer->meta['plugin']['semantic']['schema.org']['type'] = trim(str_replace('Schema.org/', '', $match), '~~');
$renderer->meta['plugin']['semantic']['enabled'] = true;
}
}
return false;
}
}