diff options
-rw-r--r-- | COPYING | 4 | ||||
-rw-r--r-- | plugins/wallabag/README.md | 29 | ||||
-rw-r--r-- | plugins/wallabag/config.php.dist | 3 | ||||
-rw-r--r-- | plugins/wallabag/wallabag.html | 1 | ||||
-rw-r--r-- | plugins/wallabag/wallabag.php | 39 | ||||
-rw-r--r-- | plugins/wallabag/wallabag.png | bin | 0 -> 369 bytes | |||
-rw-r--r-- | tests/plugins/PluginWallabagTest.php | 49 |
7 files changed, 125 insertions, 0 deletions
@@ -68,6 +68,10 @@ Files: inc/awesomplete* | |||
68 | License: MIT License (http://opensource.org/licenses/MIT) | 68 | License: MIT License (http://opensource.org/licenses/MIT) |
69 | Copyright: (C) 2015 Lea Verou - https://github.com/LeaVerou/awesomplete | 69 | Copyright: (C) 2015 Lea Verou - https://github.com/LeaVerou/awesomplete |
70 | 70 | ||
71 | Files: plugins/wallabag/wallabag.png | ||
72 | License: MIT License (http://opensource.org/licenses/MIT) | ||
73 | Copyright: (C) 2015 Nicolas Lœuillet - https://github.com/wallabag/wallabag | ||
74 | |||
71 | ---------------------------------------------------- | 75 | ---------------------------------------------------- |
72 | ZLIB/LIBPNG LICENSE | 76 | ZLIB/LIBPNG LICENSE |
73 | 77 | ||
diff --git a/plugins/wallabag/README.md b/plugins/wallabag/README.md new file mode 100644 index 00000000..08e0d44a --- /dev/null +++ b/plugins/wallabag/README.md | |||
@@ -0,0 +1,29 @@ | |||
1 | ## Save to Wallabag plugin for Shaarli | ||
2 | |||
3 | For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/). | ||
4 | |||
5 | ### Installation/configuration | ||
6 | Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. | ||
7 | The directory structure should look like: | ||
8 | |||
9 | ``` | ||
10 | └── tpl | ||
11 | └── plugins | ||
12 | └── wallabag | ||
13 | ├── README.md | ||
14 | ├── wallabag.html | ||
15 | └── wallabag.png | ||
16 | ``` | ||
17 | |||
18 | To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array) | ||
19 | . This should look like: | ||
20 | |||
21 | ``` | ||
22 | $GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag') | ||
23 | ``` | ||
24 | |||
25 | Then, set the `WALLABAG_URL` variable in `data/options.php` pointing to your wallabag URL. Example: | ||
26 | |||
27 | ``` | ||
28 | $GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation | ||
29 | ``` \ No newline at end of file | ||
diff --git a/plugins/wallabag/config.php.dist b/plugins/wallabag/config.php.dist new file mode 100644 index 00000000..7cf0d303 --- /dev/null +++ b/plugins/wallabag/config.php.dist | |||
@@ -0,0 +1,3 @@ | |||
1 | <?php | ||
2 | |||
3 | $GLOBALS['plugins']['WALLABAG_URL'] = 'https://demo.wallabag.org/'; \ No newline at end of file | ||
diff --git a/plugins/wallabag/wallabag.html b/plugins/wallabag/wallabag.html new file mode 100644 index 00000000..ddcf8126 --- /dev/null +++ b/plugins/wallabag/wallabag.html | |||
@@ -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> | |||
diff --git a/plugins/wallabag/wallabag.php b/plugins/wallabag/wallabag.php new file mode 100644 index 00000000..024a3d2b --- /dev/null +++ b/plugins/wallabag/wallabag.php | |||
@@ -0,0 +1,39 @@ | |||
1 | <?php | ||
2 | |||
3 | /** | ||
4 | * Plugin Wallabag. | ||
5 | */ | ||
6 | |||
7 | // don't raise unnecessary warnings | ||
8 | if (is_file(PluginManager::$PLUGINS_PATH . '/wallabag/config.php')) { | ||
9 | include PluginManager::$PLUGINS_PATH . '/wallabag/config.php'; | ||
10 | } | ||
11 | |||
12 | if (!isset($GLOBALS['plugins']['WALLABAG_URL'])) { | ||
13 | $GLOBALS['plugins']['errors'][] = 'Wallabag plugin error: '. | ||
14 | 'Please define "$GLOBALS[\'plugins\'][\'WALLABAG_URL\']" '. | ||
15 | 'in "plugins/wallabag/config.php" or in your Shaarli config.php file.'; | ||
16 | } | ||
17 | |||
18 | /** | ||
19 | * Add wallabag icon to link_plugin when rendering linklist. | ||
20 | * | ||
21 | * @param mixed $data - linklist data. | ||
22 | * | ||
23 | * @return mixed - linklist data with wallabag plugin. | ||
24 | */ | ||
25 | function hook_wallabag_render_linklist($data) | ||
26 | { | ||
27 | if (!isset($GLOBALS['plugins']['WALLABAG_URL'])) { | ||
28 | return $data; | ||
29 | } | ||
30 | |||
31 | $wallabag_html = file_get_contents(PluginManager::$PLUGINS_PATH . '/wallabag/wallabag.html'); | ||
32 | |||
33 | foreach ($data['links'] as &$value) { | ||
34 | $wallabag = sprintf($wallabag_html, $GLOBALS['plugins']['WALLABAG_URL'], $value['url'], PluginManager::$PLUGINS_PATH); | ||
35 | $value['link_plugin'][] = $wallabag; | ||
36 | } | ||
37 | |||
38 | return $data; | ||
39 | } | ||
diff --git a/plugins/wallabag/wallabag.png b/plugins/wallabag/wallabag.png new file mode 100644 index 00000000..70aad33b --- /dev/null +++ b/plugins/wallabag/wallabag.png | |||
Binary files differ | |||
diff --git a/tests/plugins/PluginWallabagTest.php b/tests/plugins/PluginWallabagTest.php new file mode 100644 index 00000000..7cc83f4f --- /dev/null +++ b/tests/plugins/PluginWallabagTest.php | |||
@@ -0,0 +1,49 @@ | |||
1 | <?php | ||
2 | |||
3 | /** | ||
4 | * PluginWallabagTest.php.php | ||
5 | */ | ||
6 | |||
7 | require_once 'plugins/wallabag/wallabag.php'; | ||
8 | |||
9 | /** | ||
10 | * Class PluginWallabagTest | ||
11 | * Unit test for the Wallabag plugin | ||
12 | */ | ||
13 | class PluginWallabagTest extends PHPUnit_Framework_TestCase | ||
14 | { | ||
15 | /** | ||
16 | * Reset plugin path | ||
17 | */ | ||
18 | function setUp() | ||
19 | { | ||
20 | PluginManager::$PLUGINS_PATH = 'plugins'; | ||
21 | } | ||
22 | |||
23 | /** | ||
24 | * Test render_linklist hook. | ||
25 | */ | ||
26 | function testWallabagLinklist() | ||
27 | { | ||
28 | $GLOBALS['plugins']['WALLABAG_URL'] = 'value'; | ||
29 | $str = 'http://randomstr.com/test'; | ||
30 | $data = array( | ||
31 | 'title' => $str, | ||
32 | 'links' => array( | ||
33 | array( | ||
34 | 'url' => $str, | ||
35 | ) | ||
36 | ) | ||
37 | ); | ||
38 | |||
39 | $data = hook_wallabag_render_linklist($data); | ||
40 | $link = $data['links'][0]; | ||
41 | // data shouldn't be altered | ||
42 | $this->assertEquals($str, $data['title']); | ||
43 | $this->assertEquals($str, $link['url']); | ||
44 | |||
45 | // plugin data | ||
46 | $this->assertEquals(1, count($link['link_plugin'])); | ||
47 | $this->assertNotFalse(strpos($link['link_plugin'][0], $str)); | ||
48 | } | ||
49 | } | ||