Merge pull request #281 from ArthurHoaro/plugin-wallabag
PLUGIN wallabag
This commit is contained in:
commit
66017e2893
7 changed files with 125 additions and 0 deletions
4
COPYING
4
COPYING
|
@ -68,6 +68,10 @@ Files: inc/awesomplete*
|
||||||
License: MIT License (http://opensource.org/licenses/MIT)
|
License: MIT License (http://opensource.org/licenses/MIT)
|
||||||
Copyright: (C) 2015 Lea Verou - https://github.com/LeaVerou/awesomplete
|
Copyright: (C) 2015 Lea Verou - https://github.com/LeaVerou/awesomplete
|
||||||
|
|
||||||
|
Files: plugins/wallabag/wallabag.png
|
||||||
|
License: MIT License (http://opensource.org/licenses/MIT)
|
||||||
|
Copyright: (C) 2015 Nicolas Lœuillet - https://github.com/wallabag/wallabag
|
||||||
|
|
||||||
----------------------------------------------------
|
----------------------------------------------------
|
||||||
ZLIB/LIBPNG LICENSE
|
ZLIB/LIBPNG LICENSE
|
||||||
|
|
||||||
|
|
29
plugins/wallabag/README.md
Normal file
29
plugins/wallabag/README.md
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
## Save to Wallabag plugin for Shaarli
|
||||||
|
|
||||||
|
For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
|
||||||
|
|
||||||
|
### Installation/configuration
|
||||||
|
Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
|
||||||
|
The directory structure should look like:
|
||||||
|
|
||||||
|
```
|
||||||
|
└── tpl
|
||||||
|
└── plugins
|
||||||
|
└── wallabag
|
||||||
|
├── README.md
|
||||||
|
├── wallabag.html
|
||||||
|
└── wallabag.png
|
||||||
|
```
|
||||||
|
|
||||||
|
To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array)
|
||||||
|
. This should look like:
|
||||||
|
|
||||||
|
```
|
||||||
|
$GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag')
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, set the `WALLABAG_URL` variable in `data/options.php` pointing to your wallabag URL. Example:
|
||||||
|
|
||||||
|
```
|
||||||
|
$GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation
|
||||||
|
```
|
3
plugins/wallabag/config.php.dist
Normal file
3
plugins/wallabag/config.php.dist
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
$GLOBALS['plugins']['WALLABAG_URL'] = 'https://demo.wallabag.org/';
|
1
plugins/wallabag/wallabag.html
Normal file
1
plugins/wallabag/wallabag.html
Normal file
|
@ -0,0 +1 @@
|
||||||
|
<span><a href="%s/?plainurl=%s" target="_blank"><img width="13" height="13" src="%s/wallabag/wallabag.png" title="Save to wallabag" /></a></span>
|
39
plugins/wallabag/wallabag.php
Normal file
39
plugins/wallabag/wallabag.php
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plugin Wallabag.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// don't raise unnecessary warnings
|
||||||
|
if (is_file(PluginManager::$PLUGINS_PATH . '/wallabag/config.php')) {
|
||||||
|
include PluginManager::$PLUGINS_PATH . '/wallabag/config.php';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isset($GLOBALS['plugins']['WALLABAG_URL'])) {
|
||||||
|
$GLOBALS['plugins']['errors'][] = 'Wallabag plugin error: '.
|
||||||
|
'Please define "$GLOBALS[\'plugins\'][\'WALLABAG_URL\']" '.
|
||||||
|
'in "plugins/wallabag/config.php" or in your Shaarli config.php file.';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add wallabag icon to link_plugin when rendering linklist.
|
||||||
|
*
|
||||||
|
* @param mixed $data - linklist data.
|
||||||
|
*
|
||||||
|
* @return mixed - linklist data with wallabag plugin.
|
||||||
|
*/
|
||||||
|
function hook_wallabag_render_linklist($data)
|
||||||
|
{
|
||||||
|
if (!isset($GLOBALS['plugins']['WALLABAG_URL'])) {
|
||||||
|
return $data;
|
||||||
|
}
|
||||||
|
|
||||||
|
$wallabag_html = file_get_contents(PluginManager::$PLUGINS_PATH . '/wallabag/wallabag.html');
|
||||||
|
|
||||||
|
foreach ($data['links'] as &$value) {
|
||||||
|
$wallabag = sprintf($wallabag_html, $GLOBALS['plugins']['WALLABAG_URL'], $value['url'], PluginManager::$PLUGINS_PATH);
|
||||||
|
$value['link_plugin'][] = $wallabag;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $data;
|
||||||
|
}
|
BIN
plugins/wallabag/wallabag.png
Normal file
BIN
plugins/wallabag/wallabag.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 369 B |
49
tests/plugins/PluginWallabagTest.php
Normal file
49
tests/plugins/PluginWallabagTest.php
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PluginWallabagTest.php.php
|
||||||
|
*/
|
||||||
|
|
||||||
|
require_once 'plugins/wallabag/wallabag.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class PluginWallabagTest
|
||||||
|
* Unit test for the Wallabag plugin
|
||||||
|
*/
|
||||||
|
class PluginWallabagTest extends PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Reset plugin path
|
||||||
|
*/
|
||||||
|
function setUp()
|
||||||
|
{
|
||||||
|
PluginManager::$PLUGINS_PATH = 'plugins';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test render_linklist hook.
|
||||||
|
*/
|
||||||
|
function testWallabagLinklist()
|
||||||
|
{
|
||||||
|
$GLOBALS['plugins']['WALLABAG_URL'] = 'value';
|
||||||
|
$str = 'http://randomstr.com/test';
|
||||||
|
$data = array(
|
||||||
|
'title' => $str,
|
||||||
|
'links' => array(
|
||||||
|
array(
|
||||||
|
'url' => $str,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
$data = hook_wallabag_render_linklist($data);
|
||||||
|
$link = $data['links'][0];
|
||||||
|
// data shouldn't be altered
|
||||||
|
$this->assertEquals($str, $data['title']);
|
||||||
|
$this->assertEquals($str, $link['url']);
|
||||||
|
|
||||||
|
// plugin data
|
||||||
|
$this->assertEquals(1, count($link['link_plugin']));
|
||||||
|
$this->assertNotFalse(strpos($link['link_plugin'][0], $str));
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue