]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - doc/Example-patch---add-new-via-field-for-links.html
projects / github / shaarli / Shaarli.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Bump version to v0.8.0
[github/shaarli/Shaarli.git] / doc / Example-patch---add-new-via-field-for-links.html
CommitLineData
7a32b172 1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
5409ade2 7 <title>Shaarli – Example patch add new via field for links</title>
7a32b172 8 <style type="text/css">code{white-space: pre;}</style>
5409ade2 9 <link rel="stylesheet" href="github-markdown.css">
7a32b172 10 <!--[if lt IE 9]>
5409ade2 11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
7a32b172 12 <![endif]-->
7a32b172 13</head>
14<body>
992af0b9
V		 15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
fdf88d19 18<li>Setup
992af0b9 19<ul>
fdf88d19
A		 20<li><a href="Download-and-Installation.html">Download and Installation</a></li>
21<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
992af0b9
V		 22<li><a href="Server-requirements.html">Server requirements</a></li>
23<li><a href="Server-configuration.html">Server configuration</a></li>
5409ade2 24<li><a href="Server-security.html">Server security</a></li>
992af0b9 25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea 26<li><a href="Plugins.html">Plugins</a></li>
992af0b9 27</ul></li>
5409ade2 28<li><a href="Docker.html">Docker</a></li>
992af0b9
V		 29<li><a href="Usage.html">Usage</a>
30<ul>
31<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
5409ade2 32<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
992af0b9
V		 33<li><a href="Firefox-share.html">Firefox share</a></li>
34<li><a href="RSS-feeds.html">RSS feeds</a></li>
35</ul></li>
36<li>How To
37<ul>
38<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
39<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
5409ade2 40<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
992af0b9 41<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
6335a0fc 42<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
992af0b9
V		 43</ul></li>
44<li><a href="Troubleshooting.html">Troubleshooting</a></li>
45<li><a href="Development.html">Development</a>
46<ul>
47<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
48<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
49<li><a href="Directory-structure.html">Directory structure</a></li>
50<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
51<li><a href="Plugin-System.html">Plugin System</a></li>
5409ade2 52<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
992af0b9
V		 53<li><a href="Security.html">Security</a></li>
54<li><a href="Static-analysis.html">Static analysis</a></li>
55<li><a href="Theming.html">Theming</a></li>
56<li><a href="Unit-tests.html">Unit tests</a></li>
57</ul></li>
58<li>About
59<ul>
60<li><a href="FAQ.html">FAQ</a></li>
61<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
992af0b9
V		 62</ul></li>
63</ul>
64</div>
65<h1 id="example-patch-add-new-via-field-for-links">Example patch add new via field for links</h1>
7a32b172 66<p>Example patch to add a new field (&quot;via&quot;) for links, an input field to set the &quot;via&quot; property from the &quot;edit link&quot; dialog, and display the &quot;via&quot; field in the link list display. <strong>Untested, use at your own risk</strong></p>
992af0b9 67<p>Thanks to @Knah-Tsaeb in <a href="https://github.com/sebsauvage/Shaarli/pull/158" class="uri">https://github.com/sebsauvage/Shaarli/pull/158</a></p>
7a32b172 68<pre><code>From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001
69From: Knah Tsaeb &lt;knah-tsaeb@knah-tsaeb.org&gt;
70Date: Fri, 11 Oct 2013 15:18:37 +0200
992af0b9 71Subject: [PATCH] Add a &quot;via&quot;/origin property for links, add new input in &quot;edit link&quot; dialog[](.html)
7a32b172 72Thanks to:
73* https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4
74* https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813
75* https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96
76
77---
78 index.php | 43 ++++++++++++++++++++++++++++++++-----------
79 tpl/editlink.html | 1 +
80 tpl/linklist.html | 1 +
81 3 files changed, 34 insertions(+), 11 deletions(-)
82
83diff --git a/index.php b/index.php
84index 6fae2f8..53f798e 100644
85--- a/index.php
86+++ b/index.php
992af0b9 87@@ -436,6 +436,12 @@ if (isset($_POST[&#39;login&#39;]))[](.html)
7a32b172 88 // ------------------------------------------------------------------------------------------
89 // Misc utility functions:
90
91+// Try to get just domain for @via
92+function getJustDomain($url){
93+ $parts = parse_url($url);
992af0b9 94+ return trim($parts[&#39;host&#39;]);[](.html)
7a32b172 95+ }
96+
97 // Returns the server URL (including port and http/https), without path.
98 // e.g. &quot;http://myserver.com:8080&quot;
992af0b9 99 // You can append $_SERVER[&#39;SCRIPT_NAME&#39;] to get the current script URL.[](.html)
7a32b172 100@@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess
992af0b9
V		 101 $found= (strpos(strtolower($l[&#39;title&#39;]),$s)!==false)[](.html)
102 || (strpos(strtolower($l[&#39;description&#39;]),$s)!==false)[](.html)
103 || (strpos(strtolower($l[&#39;url&#39;]),$s)!==false)[](.html)
104- || (strpos(strtolower($l[&#39;tags&#39;]),$s)!==false);[](.html)
105+ || (strpos(strtolower($l[&#39;tags&#39;]),$s)!==false)[](.html)
106+ || (!empty($l[&#39;via&#39;]) &amp;&amp; (strpos(strtolower($l[&#39;via&#39;]),$s)!==false));[](.html)
107 if ($found) $filtered[$l[&#39;linkdate&#39;[ = $l;](-=-$l;.html)
7a32b172 108 }
109 krsort($filtered);
110@@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess
111 $t = str_replace(&#39;,&#39;,&#39; &#39;,($casesensitive?$tags:strtolower($tags)));
112 $searchtags=explode(&#39; &#39;,$t);
113 $filtered=array();
114- foreach($this-&gt;links as $l)
115+ foreach($this-&gt; links as $l)
116 {
992af0b9 117 $linktags = explode(&#39; &#39;,($casesensitive?$l[&#39;tags&#39;]:strtolower($l[&#39;tags&#39;])));[](.html)
7a32b172 118 if (count(array_intersect($linktags,$searchtags)) == count($searchtags))
119@@ -905,7 +912,7 @@ function showRSS()
120 else $linksToDisplay = $LINKSDB;
121 $nblinksToDisplay = 50; // Number of links to display.
992af0b9 122 if (!empty($_GET[&#39;nb&#39;])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html)
7a32b172 123- {
124+ {
992af0b9 125 $nblinksToDisplay = $_GET[&#39;nb&#39;]==&#39;all&#39; ? count($linksToDisplay) : max($_GET[&#39;nb&#39;]+0,1) ;[](.html)
7a32b172 126 }
127
128@@ -944,7 +951,12 @@ function showRSS()
129 // If user wants permalinks first, put the final link in description
130 if ($usepermalinks===true) $descriptionlink = &#39;(&lt;a href=&quot;&#39;.$absurl.&#39;&quot;&gt;Link&lt;/a&gt;)&#39;;
992af0b9
V		 131 if (strlen($link[&#39;description&#39;])&gt;0) $descriptionlink = &#39;&lt;br&gt;&#39;.$descriptionlink;[](.html)
132- echo &#39;&lt;description&gt;&lt;![CDATA[&#39;.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link[&#39;description&#39;])))).$descriptionlink.&#39;[&gt;&lt;/description&gt;&#39;.&quot;\n&lt;/item&gt;\n&quot;;](&gt;&lt;/description&gt;&#39;.&quot;\n&lt;/item&gt;\n&quot;;.html)
133+ if(!empty($link[&#39;via&#39;])){[](.html)
134+ $via = &#39;&lt;br&gt;Origine =&gt; &lt;a href=&quot;&#39;.htmlspecialchars($link[&#39;via&#39;]).&#39;&quot;&gt;&#39;.htmlspecialchars(getJustDomain($link[&#39;via&#39;])).&#39;&lt;/a&gt;&#39;;[](.html)
7a32b172 135+ } else {
136+ $via = &#39;&#39;;
137+ }
992af0b9 138+ echo &#39;&lt;description&gt;&lt;![CDATA[&#39;.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link[&#39;description&#39;])))).$via.$descriptionlink.&#39;[&gt;&lt;/description&gt;&#39;.&quot;\n&lt;/item&gt;\n&quot;;](&gt;&lt;/description&gt;&#39;.&quot;\n&lt;/item&gt;\n&quot;;.html)
7a32b172 139 $i++;
140 }
141 echo &#39;&lt;/channel&gt;&lt;/rss&gt;&lt;!-- Cached version of &#39;.htmlspecialchars(pageUrl()).&#39; --&gt;&#39;;
142@@ -980,7 +992,7 @@ function showATOM()
143 else $linksToDisplay = $LINKSDB;
144 $nblinksToDisplay = 50; // Number of links to display.
992af0b9 145 if (!empty($_GET[&#39;nb&#39;])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html)
7a32b172 146- {
147+ {
992af0b9 148 $nblinksToDisplay = $_GET[&#39;nb&#39;]==&#39;all&#39; ? count($linksToDisplay) : max($_GET[&#39;nb&#39;]+0,1) ;[](.html)
7a32b172 149 }
150
151@@ -1006,11 +1018,16 @@ function showATOM()
152
153 // Add permalink in description
154 $descriptionlink = htmlspecialchars(&#39;(&lt;a href=&quot;&#39;.$guid.&#39;&quot;&gt;Permalink&lt;/a&gt;)&#39;);
992af0b9
V		 155+ if(isset($link[&#39;via&#39;]) &amp;&amp; !empty($link[&#39;via&#39;])){[](.html)
156+ $via = htmlspecialchars(&#39;&lt;/br&gt; Origine =&gt; &lt;a href=&quot;&#39;.$link[&#39;via&#39;].&#39;&quot;&gt;&#39;.getJustDomain($link[&#39;via&#39;]).&#39;&lt;/a&gt;&#39;);[](.html)
7a32b172 157+ } else {
158+ $via = &#39;&#39;;
159+ }
160 // If user wants permalinks first, put the final link in description
161 if ($usepermalinks===true) $descriptionlink = htmlspecialchars(&#39;(&lt;a href=&quot;&#39;.$absurl.&#39;&quot;&gt;Link&lt;/a&gt;)&#39;);
992af0b9 162 if (strlen($link[&#39;description&#39;])&gt;0) $descriptionlink = &#39;&amp;lt;br&amp;gt;&#39;.$descriptionlink;[](.html)
7a32b172 163
992af0b9
V		 164- $entries.=&#39;&lt;content type=&quot;html&quot;&gt;&#39;.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link[&#39;description&#39;]))))).$descriptionlink.&quot;&lt;/content&gt;\n&quot;;[](.html)
165+ $entries.=&#39;&lt;content type=&quot;html&quot;&gt;&#39;.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link[&#39;description&#39;]))))).$descriptionlink.$via.&quot;&lt;/content&gt;\n&quot;;[](.html)
166 if ($link[&#39;tags&#39;]!=&#39;&#39;) // Adding tags to each ATOM entry (as mentioned in ATOM specification)[](.html)
7a32b172 167 {
992af0b9 168 foreach(explode(&#39; &#39;,$link[&#39;tags&#39;]) as $tag)[](.html)
7a32b172 169@@ -1478,7 +1495,7 @@ function renderPage()
170 if (!startsWith($url,&#39;http:&#39;) &amp;&amp; !startsWith($url,&#39;https:&#39;) &amp;&amp; !startsWith($url,&#39;ftp:&#39;) &amp;&amp; !startsWith($url,&#39;magnet:&#39;) &amp;&amp; !startsWith($url,&#39;?&#39;))
171 $url = &#39;http://&#39;.$url;
992af0b9 172 $link = array(&#39;title&#39;=&gt;trim($_POST[&#39;lf_title&#39;]),&#39;url&#39;=&gt;$url,&#39;description&#39;=&gt;trim($_POST[&#39;lf_description&#39;]),&#39;private&#39;=&gt;(isset($_POST[&#39;lf_private&#39;]) ? 1 : 0),[](.html)
7a32b172 173- &#39;linkdate&#39;=&gt;$linkdate,&#39;tags&#39;=&gt;str_replace(&#39;,&#39;,&#39; &#39;,$tags));
992af0b9
V		 174+ &#39;linkdate&#39;=&gt;$linkdate,&#39;tags&#39;=&gt;str_replace(&#39;,&#39;,&#39; &#39;,$tags), &#39;via&#39;=&gt;trim($_POST[&#39;lf_via&#39;]));[](.html)
175 if ($link[&#39;title&#39;]==&#39;&#39;) $link[&#39;title&#39;]=$link[&#39;url&#39;]; // If title is empty, use the URL as title.[](.html)
176 $LINKSDB[$linkdate] = $link;[](.html)
7a32b172 177 $LINKSDB-&gt;savedb(); // Save to disk.
178@@ -1556,7 +1573,8 @@ function renderPage()
992af0b9
V		 179 $title = (empty($_GET[&#39;title&#39;]) ? &#39;&#39; : $_GET[&#39;title&#39;] ); // Get title if it was provided in URL (by the bookmarklet).[](.html)
180 $description = (empty($_GET[&#39;description&#39;]) ? &#39;&#39; : $_GET[&#39;description&#39;]); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that][](.html)
181 $tags = (empty($_GET[&#39;tags&#39;]) ? &#39;&#39; : $_GET[&#39;tags&#39;] ); // Get tags if it was provided in URL[](.html)
182- $private = (!empty($_GET[&#39;private&#39;]) &amp;&amp; $_GET[&#39;private&#39;] === &quot;1&quot; ? 1 : 0); // Get private if it was provided in URL [](.html)
183+ $via = (empty($_GET[&#39;via&#39;]) ? &#39;&#39; : $_GET[&#39;via&#39;] );[](.html)
184+ $private = (!empty($_GET[&#39;private&#39;]) &amp;&amp; $_GET[&#39;private&#39;] === &quot;1&quot; ? 1 : 0); // Get private if it was provided in URL[](.html)
7a32b172 185 if (($url!=&#39;&#39;) &amp;&amp; parse_url($url,PHP_URL_SCHEME)==&#39;&#39;) $url = &#39;http://&#39;.$url;
186 // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.)
187 if (empty($title) &amp;&amp; parse_url($url,PHP_URL_SCHEME)==&#39;http&#39;)
188@@ -1567,7 +1585,7 @@ function renderPage()
189 {
190 // Look for charset in html header.
191 preg_match(&#39;#&lt;meta .*charset=.*&gt;#Usi&#39;, $data, $meta);
192-
193+
194 // If found, extract encoding.
992af0b9 195 if (!empty($meta[0]))[](.html)
7a32b172 196 {
197@@ -1577,7 +1595,7 @@ function renderPage()
992af0b9 198 $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : &#39;utf-8&#39;;[](.html)
7a32b172 199 }
200 else { $html_charset = &#39;utf-8&#39;; }
201-
202+
203 // Extract title
204 $title = html_extract_title($data);
205 if (!empty($title))
206@@ -1592,7 +1610,7 @@ function renderPage()
207 $url=&#39;?&#39;.smallHash($linkdate);
208 $title=&#39;Note: &#39;;
209 }
210- $link = array(&#39;linkdate&#39;=&gt;$linkdate,&#39;title&#39;=&gt;$title,&#39;url&#39;=&gt;$url,&#39;description&#39;=&gt;$description,&#39;tags&#39;=&gt;$tags,&#39;private&#39;=&gt;$private);
211+ $link = array(&#39;linkdate&#39;=&gt;$linkdate,&#39;title&#39;=&gt;$title,&#39;url&#39;=&gt;$url,&#39;description&#39;=&gt;$description,&#39;tags&#39;=&gt;$tags,&#39;via&#39; =&gt; $via,&#39;private&#39;=&gt;$private);
212 }
213
214 $PAGE = new pageBuilder;
215@@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB)
992af0b9 216 $taglist = explode(&#39; &#39;,$link[&#39;tags&#39;]);[](.html)
7a32b172 217 uasort($taglist, &#39;strcasecmp&#39;);
992af0b9
V		 218 $link[&#39;taglist&#39;]=$taglist;[](.html)
219+ if(!empty($link[&#39;via&#39;])){[](.html)
220+ $link[&#39;via&#39;]=htmlspecialchars($link[&#39;via&#39;]);[](.html)
7a32b172 221+ }
992af0b9 222 $linkDisp[$keys[$i[ = $link;](-=-$link;.html)
7a32b172 223 $i++;
224 }
225diff --git a/tpl/editlink.html b/tpl/editlink.html
226index 4a2c30c..14d4f9c 100644
227--- a/tpl/editlink.html
228+++ b/tpl/editlink.html
229@@ -16,6 +16,7 @@
230 &lt;i&gt;Title&lt;/i&gt;&lt;br&gt;&lt;input type=&quot;text&quot; name=&quot;lf_title&quot; value=&quot;{$link.title|htmlspecialchars}&quot; style=&quot;width:100%&quot;&gt;&lt;br&gt;
231 &lt;i&gt;Description&lt;/i&gt;&lt;br&gt;&lt;textarea name=&quot;lf_description&quot; rows=&quot;4&quot; cols=&quot;25&quot; style=&quot;width:100%&quot;&gt;{$link.description|htmlspecialchars}&lt;/textarea&gt;&lt;br&gt;
232 &lt;i&gt;Tags&lt;/i&gt;&lt;br&gt;&lt;input type=&quot;text&quot; id=&quot;lf_tags&quot; name=&quot;lf_tags&quot; value=&quot;{$link.tags|htmlspecialchars}&quot; style=&quot;width:100%&quot;&gt;&lt;br&gt;
233+ &lt;i&gt;Origine&lt;/i&gt;&lt;br&gt;&lt;input type=&quot;text&quot; name=&quot;lf_via&quot; value=&quot;{$link.via|htmlspecialchars}&quot; style=&quot;width:100%&quot;&gt;&lt;br&gt;
992af0b9 234 {if condition=&quot;($link_is_new &amp;&amp; $GLOBALS[&#39;privateLinkByDefault&#39;]==true) || $link.private == true&quot;}[](.html)
7a32b172 235 &lt;input type=&quot;checkbox&quot; checked=&quot;checked&quot; name=&quot;lf_private&quot; id=&quot;lf_private&quot;&gt;
236 &amp;nbsp;&lt;label for=&quot;lf_private&quot;&gt;&lt;i&gt;Private&lt;/i&gt;&lt;/label&gt;&lt;br&gt;
237diff --git a/tpl/linklist.html b/tpl/linklist.html
238index ddc38cb..0a8475f 100644
239--- a/tpl/linklist.html
240+++ b/tpl/linklist.html
241@@ -43,6 +43,7 @@
242 &lt;span class=&quot;linktitle&quot;&gt;&lt;a href=&quot;{$redirector}{$value.url|htmlspecialchars}&quot;&gt;{$value.title|htmlspecialchars}&lt;/a&gt;&lt;/span&gt;
243 &lt;br&gt;
244 {if=&quot;$value.description&quot;}&lt;div class=&quot;linkdescription&quot;{if condition=&quot;$search_type==&#39;permalink&#39;&quot;} style=&quot;max-height:none !important;&quot;{/if}&gt;{$value.description}&lt;/div&gt;{/if}
245+ {if condition=&quot;isset($value.via) &amp;&amp; !empty($value.via)&quot;}&lt;div&gt;&lt;a href=&quot;{$value.via}&quot;&gt;Origine =&gt; {$value.via|getJustDomain}&lt;/a&gt;&lt;/div&gt;{/if}
992af0b9 246 {if=&quot;!$GLOBALS[&#39;config&#39;[&#39;HIDE_TIMESTAMPS&#39;] || isLoggedIn()&quot;}](&#39;HIDE_TIMESTAMPS&#39;]-||-isLoggedIn()&quot;}.html)
7a32b172 247 &lt;span class=&quot;linkdate&quot; title=&quot;Permalink&quot;&gt;&lt;a href=&quot;?{$value.linkdate|smallHash}&quot;&gt;{$value.localdate|htmlspecialchars} - permalink&lt;/a&gt; - &lt;/span&gt;
248 {else}
249--
2502.1.1</code></pre>
251</body>
252</html>
The personal, minimalist, super-fast, database free, bookmarking service - community repo