Example-patch---add-new-via-field-for-links.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  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">
  7. <title>Shaarli - Example patch add new via field for links</title>
  8. <style type="text/css">code{white-space: pre;}</style>
  9. <!--[if lt IE 9]>
  10. <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  11. <![endif]-->
  12. <link rel="stylesheet" href="github-markdown.css">
  13. </head>
  14. <body>
  15. <div id="local-sidebar">
  16. <ul>
  17. <li><a href="Home.html">Home</a></li>
  18. <li>Installation
  19. <ul>
  20. <li><a href="Download.html">Download</a></li>
  21. <li><a href="Server-requirements.html">Server requirements</a></li>
  22. <li><a href="Server-configuration.html">Server configuration</a></li>
  23. <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  24. </ul></li>
  25. <li><a href="Usage.html">Usage</a>
  26. <ul>
  27. <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  28. <li><a href="Firefox-share.html">Firefox share</a></li>
  29. <li><a href="RSS-feeds.html">RSS feeds</a></li>
  30. </ul></li>
  31. <li>How To
  32. <ul>
  33. <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  34. <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>
  35. <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  36. <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  37. </ul></li>
  38. <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  39. <li><a href="Development.html">Development</a>
  40. <ul>
  41. <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  42. <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  43. <li><a href="Directory-structure.html">Directory structure</a></li>
  44. <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  45. <li><a href="Plugin-System.html">Plugin System</a></li>
  46. <li><a href="Security.html">Security</a></li>
  47. <li><a href="Static-analysis.html">Static analysis</a></li>
  48. <li><a href="Theming.html">Theming</a></li>
  49. <li><a href="Unit-tests.html">Unit tests</a></li>
  50. </ul></li>
  51. <li>About
  52. <ul>
  53. <li><a href="FAQ.html">FAQ</a></li>
  54. <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  55. <li><a href="TODO.html">TODO</a></li>
  56. </ul></li>
  57. </ul>
  58. </div>
  59. <h1 id="example-patch-add-new-via-field-for-links">Example patch add new via field for links</h1>
  60. <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>
  61. <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>
  62. <pre><code>From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001
  63. From: Knah Tsaeb &lt;knah-tsaeb@knah-tsaeb.org&gt;
  64. Date: Fri, 11 Oct 2013 15:18:37 +0200
  65. Subject: [PATCH] Add a &quot;via&quot;/origin property for links, add new input in &quot;edit link&quot; dialog[](.html)
  66. Thanks to:
  67. * https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4
  68. * https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813
  69. * https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96
  70. ---
  71. index.php | 43 ++++++++++++++++++++++++++++++++-----------
  72. tpl/editlink.html | 1 +
  73. tpl/linklist.html | 1 +
  74. 3 files changed, 34 insertions(+), 11 deletions(-)
  75. diff --git a/index.php b/index.php
  76. index 6fae2f8..53f798e 100644
  77. --- a/index.php
  78. +++ b/index.php
  79. @@ -436,6 +436,12 @@ if (isset($_POST[&#39;login&#39;]))[](.html)
  80. // ------------------------------------------------------------------------------------------
  81. // Misc utility functions:
  82. +// Try to get just domain for @via
  83. +function getJustDomain($url){
  84. + $parts = parse_url($url);
  85. + return trim($parts[&#39;host&#39;]);[](.html)
  86. + }
  87. +
  88. // Returns the server URL (including port and http/https), without path.
  89. // e.g. &quot;http://myserver.com:8080&quot;
  90. // You can append $_SERVER[&#39;SCRIPT_NAME&#39;] to get the current script URL.[](.html)
  91. @@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess
  92. $found= (strpos(strtolower($l[&#39;title&#39;]),$s)!==false)[](.html)
  93. || (strpos(strtolower($l[&#39;description&#39;]),$s)!==false)[](.html)
  94. || (strpos(strtolower($l[&#39;url&#39;]),$s)!==false)[](.html)
  95. - || (strpos(strtolower($l[&#39;tags&#39;]),$s)!==false);[](.html)
  96. + || (strpos(strtolower($l[&#39;tags&#39;]),$s)!==false)[](.html)
  97. + || (!empty($l[&#39;via&#39;]) &amp;&amp; (strpos(strtolower($l[&#39;via&#39;]),$s)!==false));[](.html)
  98. if ($found) $filtered[$l[&#39;linkdate&#39;[ = $l;](-=-$l;.html)
  99. }
  100. krsort($filtered);
  101. @@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess
  102. $t = str_replace(&#39;,&#39;,&#39; &#39;,($casesensitive?$tags:strtolower($tags)));
  103. $searchtags=explode(&#39; &#39;,$t);
  104. $filtered=array();
  105. - foreach($this-&gt;links as $l)
  106. + foreach($this-&gt; links as $l)
  107. {
  108. $linktags = explode(&#39; &#39;,($casesensitive?$l[&#39;tags&#39;]:strtolower($l[&#39;tags&#39;])));[](.html)
  109. if (count(array_intersect($linktags,$searchtags)) == count($searchtags))
  110. @@ -905,7 +912,7 @@ function showRSS()
  111. else $linksToDisplay = $LINKSDB;
  112. $nblinksToDisplay = 50; // Number of links to display.
  113. 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)
  114. - {
  115. + {
  116. $nblinksToDisplay = $_GET[&#39;nb&#39;]==&#39;all&#39; ? count($linksToDisplay) : max($_GET[&#39;nb&#39;]+0,1) ;[](.html)
  117. }
  118. @@ -944,7 +951,12 @@ function showRSS()
  119. // If user wants permalinks first, put the final link in description
  120. if ($usepermalinks===true) $descriptionlink = &#39;(&lt;a href=&quot;&#39;.$absurl.&#39;&quot;&gt;Link&lt;/a&gt;)&#39;;
  121. if (strlen($link[&#39;description&#39;])&gt;0) $descriptionlink = &#39;&lt;br&gt;&#39;.$descriptionlink;[](.html)
  122. - 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)
  123. + if(!empty($link[&#39;via&#39;])){[](.html)
  124. + $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)
  125. + } else {
  126. + $via = &#39;&#39;;
  127. + }
  128. + 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)
  129. $i++;
  130. }
  131. echo &#39;&lt;/channel&gt;&lt;/rss&gt;&lt;!-- Cached version of &#39;.htmlspecialchars(pageUrl()).&#39; --&gt;&#39;;
  132. @@ -980,7 +992,7 @@ function showATOM()
  133. else $linksToDisplay = $LINKSDB;
  134. $nblinksToDisplay = 50; // Number of links to display.
  135. 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)
  136. - {
  137. + {
  138. $nblinksToDisplay = $_GET[&#39;nb&#39;]==&#39;all&#39; ? count($linksToDisplay) : max($_GET[&#39;nb&#39;]+0,1) ;[](.html)
  139. }
  140. @@ -1006,11 +1018,16 @@ function showATOM()
  141. // Add permalink in description
  142. $descriptionlink = htmlspecialchars(&#39;(&lt;a href=&quot;&#39;.$guid.&#39;&quot;&gt;Permalink&lt;/a&gt;)&#39;);
  143. + if(isset($link[&#39;via&#39;]) &amp;&amp; !empty($link[&#39;via&#39;])){[](.html)
  144. + $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)
  145. + } else {
  146. + $via = &#39;&#39;;
  147. + }
  148. // If user wants permalinks first, put the final link in description
  149. if ($usepermalinks===true) $descriptionlink = htmlspecialchars(&#39;(&lt;a href=&quot;&#39;.$absurl.&#39;&quot;&gt;Link&lt;/a&gt;)&#39;);
  150. if (strlen($link[&#39;description&#39;])&gt;0) $descriptionlink = &#39;&amp;lt;br&amp;gt;&#39;.$descriptionlink;[](.html)
  151. - $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)
  152. + $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)
  153. if ($link[&#39;tags&#39;]!=&#39;&#39;) // Adding tags to each ATOM entry (as mentioned in ATOM specification)[](.html)
  154. {
  155. foreach(explode(&#39; &#39;,$link[&#39;tags&#39;]) as $tag)[](.html)
  156. @@ -1478,7 +1495,7 @@ function renderPage()
  157. 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;))
  158. $url = &#39;http://&#39;.$url;
  159. $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)
  160. - &#39;linkdate&#39;=&gt;$linkdate,&#39;tags&#39;=&gt;str_replace(&#39;,&#39;,&#39; &#39;,$tags));
  161. + &#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)
  162. 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)
  163. $LINKSDB[$linkdate] = $link;[](.html)
  164. $LINKSDB-&gt;savedb(); // Save to disk.
  165. @@ -1556,7 +1573,8 @@ function renderPage()
  166. $title = (empty($_GET[&#39;title&#39;]) ? &#39;&#39; : $_GET[&#39;title&#39;] ); // Get title if it was provided in URL (by the bookmarklet).[](.html)
  167. $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)
  168. $tags = (empty($_GET[&#39;tags&#39;]) ? &#39;&#39; : $_GET[&#39;tags&#39;] ); // Get tags if it was provided in URL[](.html)
  169. - $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)
  170. + $via = (empty($_GET[&#39;via&#39;]) ? &#39;&#39; : $_GET[&#39;via&#39;] );[](.html)
  171. + $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)
  172. if (($url!=&#39;&#39;) &amp;&amp; parse_url($url,PHP_URL_SCHEME)==&#39;&#39;) $url = &#39;http://&#39;.$url;
  173. // 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.)
  174. if (empty($title) &amp;&amp; parse_url($url,PHP_URL_SCHEME)==&#39;http&#39;)
  175. @@ -1567,7 +1585,7 @@ function renderPage()
  176. {
  177. // Look for charset in html header.
  178. preg_match(&#39;#&lt;meta .*charset=.*&gt;#Usi&#39;, $data, $meta);
  179. -
  180. +
  181. // If found, extract encoding.
  182. if (!empty($meta[0]))[](.html)
  183. {
  184. @@ -1577,7 +1595,7 @@ function renderPage()
  185. $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : &#39;utf-8&#39;;[](.html)
  186. }
  187. else { $html_charset = &#39;utf-8&#39;; }
  188. -
  189. +
  190. // Extract title
  191. $title = html_extract_title($data);
  192. if (!empty($title))
  193. @@ -1592,7 +1610,7 @@ function renderPage()
  194. $url=&#39;?&#39;.smallHash($linkdate);
  195. $title=&#39;Note: &#39;;
  196. }
  197. - $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);
  198. + $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);
  199. }
  200. $PAGE = new pageBuilder;
  201. @@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB)
  202. $taglist = explode(&#39; &#39;,$link[&#39;tags&#39;]);[](.html)
  203. uasort($taglist, &#39;strcasecmp&#39;);
  204. $link[&#39;taglist&#39;]=$taglist;[](.html)
  205. + if(!empty($link[&#39;via&#39;])){[](.html)
  206. + $link[&#39;via&#39;]=htmlspecialchars($link[&#39;via&#39;]);[](.html)
  207. + }
  208. $linkDisp[$keys[$i[ = $link;](-=-$link;.html)
  209. $i++;
  210. }
  211. diff --git a/tpl/editlink.html b/tpl/editlink.html
  212. index 4a2c30c..14d4f9c 100644
  213. --- a/tpl/editlink.html
  214. +++ b/tpl/editlink.html
  215. @@ -16,6 +16,7 @@
  216. &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;
  217. &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;
  218. &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;
  219. + &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;
  220. {if condition=&quot;($link_is_new &amp;&amp; $GLOBALS[&#39;privateLinkByDefault&#39;]==true) || $link.private == true&quot;}[](.html)
  221. &lt;input type=&quot;checkbox&quot; checked=&quot;checked&quot; name=&quot;lf_private&quot; id=&quot;lf_private&quot;&gt;
  222. &amp;nbsp;&lt;label for=&quot;lf_private&quot;&gt;&lt;i&gt;Private&lt;/i&gt;&lt;/label&gt;&lt;br&gt;
  223. diff --git a/tpl/linklist.html b/tpl/linklist.html
  224. index ddc38cb..0a8475f 100644
  225. --- a/tpl/linklist.html
  226. +++ b/tpl/linklist.html
  227. @@ -43,6 +43,7 @@
  228. &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;
  229. &lt;br&gt;
  230. {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}
  231. + {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}
  232. {if=&quot;!$GLOBALS[&#39;config&#39;[&#39;HIDE_TIMESTAMPS&#39;] || isLoggedIn()&quot;}](&#39;HIDE_TIMESTAMPS&#39;]-||-isLoggedIn()&quot;}.html)
  233. &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;
  234. {else}
  235. --
  236. 2.1.1</code></pre>
  237. </body>
  238. </html>