doc/Example-patch---add-new-via-field-for-links.html

   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></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 <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>
  16 <p>Thanks to @Knah-Tsaeb in <a href="https://github.com/sebsauvage/Shaarli/pull/158">https://github.com/sebsauvage/Shaarli/pull/158</a></p>
  17 <pre><code>From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001
  18 From: Knah Tsaeb &lt;knah-tsaeb@knah-tsaeb.org&gt;
  19 Date: Fri, 11 Oct 2013 15:18:37 +0200
  20 Subject: [PATCH] Add a &quot;via&quot;/origin property for links, add new input in &quot;edit link&quot; dialog
  21 Thanks to:
  22 * https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4
  23 * https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813
  24 * https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96
  25
  26 ---
  27  index.php         | 43 ++++++++++++++++++++++++++++++++-----------
  28  tpl/editlink.html |  1 +
  29  tpl/linklist.html |  1 +
  30  3 files changed, 34 insertions(+), 11 deletions(-)
  31
  32 diff --git a/index.php b/index.php
  33 index 6fae2f8..53f798e 100644
  34 --- a/index.php
  35 +++ b/index.php
  36 @@ -436,6 +436,12 @@ if (isset($_POST[&#39;login&#39;]))
  37  // ------------------------------------------------------------------------------------------
  38  // Misc utility functions:
  39
  40 +// Try to get just domain for @via
  41 +function getJustDomain($url){
  42 +    $parts = parse_url($url);
  43 +    return trim($parts[&#39;host&#39;]);
  44 +    }
  45 +
  46  // Returns the server URL (including port and http/https), without path.
  47  // e.g. &quot;http://myserver.com:8080&quot;
  48  // You can append $_SERVER[&#39;SCRIPT_NAME&#39;] to get the current script URL.
  49 @@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess
  50              $found=   (strpos(strtolower($l[&#39;title&#39;]),$s)!==false)
  51                     || (strpos(strtolower($l[&#39;description&#39;]),$s)!==false)
  52                     || (strpos(strtolower($l[&#39;url&#39;]),$s)!==false)
  53 -                   || (strpos(strtolower($l[&#39;tags&#39;]),$s)!==false);
  54 +                   || (strpos(strtolower($l[&#39;tags&#39;]),$s)!==false)
  55 +                   || (!empty($l[&#39;via&#39;]) &amp;&amp; (strpos(strtolower($l[&#39;via&#39;]),$s)!==false));
  56              if ($found) $filtered[$l[&#39;linkdate&#39;]] = $l;
  57          }
  58          krsort($filtered);
  59 @@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess
  60          $t = str_replace(&#39;,&#39;,&#39; &#39;,($casesensitive?$tags:strtolower($tags)));
  61          $searchtags=explode(&#39; &#39;,$t);
  62          $filtered=array();
  63 -        foreach($this-&gt;links as $l)
  64 +        foreach($this-&gt; links as $l)
  65          {
  66              $linktags = explode(&#39; &#39;,($casesensitive?$l[&#39;tags&#39;]:strtolower($l[&#39;tags&#39;])));
  67              if (count(array_intersect($linktags,$searchtags)) == count($searchtags))
  68 @@ -905,7 +912,7 @@ function showRSS()
  69      else $linksToDisplay = $LINKSDB;
  70      $nblinksToDisplay = 50;  // Number of links to display.
  71      if (!empty($_GET[&#39;nb&#39;]))  // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.
  72 -    {
  73 +    {
  74          $nblinksToDisplay = $_GET[&#39;nb&#39;]==&#39;all&#39; ? count($linksToDisplay) : max($_GET[&#39;nb&#39;]+0,1) ;
  75      }
  76
  77 @@ -944,7 +951,12 @@ function showRSS()
  78          // If user wants permalinks first, put the final link in description
  79          if ($usepermalinks===true) $descriptionlink = &#39;(&lt;a href=&quot;&#39;.$absurl.&#39;&quot;&gt;Link&lt;/a&gt;)&#39;;
  80          if (strlen($link[&#39;description&#39;])&gt;0) $descriptionlink = &#39;&lt;br&gt;&#39;.$descriptionlink;
  81 -        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;;
  82 +        if(!empty($link[&#39;via&#39;])){
  83 +          $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;;
  84 +        } else {
  85 +         $via = &#39;&#39;;
  86 +        }
  87 +        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;;
  88          $i++;
  89      }
  90      echo &#39;&lt;/channel&gt;&lt;/rss&gt;&lt;!-- Cached version of &#39;.htmlspecialchars(pageUrl()).&#39; --&gt;&#39;;
  91 @@ -980,7 +992,7 @@ function showATOM()
  92      else $linksToDisplay = $LINKSDB;
  93      $nblinksToDisplay = 50;  // Number of links to display.
  94      if (!empty($_GET[&#39;nb&#39;]))  // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.
  95 -    {
  96 +    {
  97          $nblinksToDisplay = $_GET[&#39;nb&#39;]==&#39;all&#39; ? count($linksToDisplay) : max($_GET[&#39;nb&#39;]+0,1) ;
  98      }
  99
 100 @@ -1006,11 +1018,16 @@ function showATOM()
 101
 102          // Add permalink in description
 103          $descriptionlink = htmlspecialchars(&#39;(&lt;a href=&quot;&#39;.$guid.&#39;&quot;&gt;Permalink&lt;/a&gt;)&#39;);
 104 +        if(isset($link[&#39;via&#39;]) &amp;&amp; !empty($link[&#39;via&#39;])){
 105 +          $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;);
 106 +        } else {
 107 +          $via = &#39;&#39;;
 108 +        }
 109          // If user wants permalinks first, put the final link in description
 110          if ($usepermalinks===true) $descriptionlink = htmlspecialchars(&#39;(&lt;a href=&quot;&#39;.$absurl.&#39;&quot;&gt;Link&lt;/a&gt;)&#39;);
 111          if (strlen($link[&#39;description&#39;])&gt;0) $descriptionlink = &#39;&amp;lt;br&amp;gt;&#39;.$descriptionlink;
 112
 113 -        $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;;
 114 +        $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;;
 115          if ($link[&#39;tags&#39;]!=&#39;&#39;) // Adding tags to each ATOM entry (as mentioned in ATOM specification)
 116          {
 117              foreach(explode(&#39; &#39;,$link[&#39;tags&#39;]) as $tag)
 118 @@ -1478,7 +1495,7 @@ function renderPage()
 119          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;))
 120              $url = &#39;http://&#39;.$url;
 121          $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),
 122 -                      &#39;linkdate&#39;=&gt;$linkdate,&#39;tags&#39;=&gt;str_replace(&#39;,&#39;,&#39; &#39;,$tags));
 123 +                      &#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;]));
 124          if ($link[&#39;title&#39;]==&#39;&#39;) $link[&#39;title&#39;]=$link[&#39;url&#39;]; // If title is empty, use the URL as title.
 125          $LINKSDB[$linkdate] = $link;
 126          $LINKSDB-&gt;savedb(); // Save to disk.
 127 @@ -1556,7 +1573,8 @@ function renderPage()
 128              $title = (empty($_GET[&#39;title&#39;]) ? &#39;&#39; : $_GET[&#39;title&#39;] ); // Get title if it was provided in URL (by the bookmarklet).
 129              $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]
 130              $tags = (empty($_GET[&#39;tags&#39;]) ? &#39;&#39; : $_GET[&#39;tags&#39;] ); // Get tags if it was provided in URL
 131 -            $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
 132 +            $via = (empty($_GET[&#39;via&#39;]) ? &#39;&#39; : $_GET[&#39;via&#39;] );
 133 +            $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
 134              if (($url!=&#39;&#39;) &amp;&amp; parse_url($url,PHP_URL_SCHEME)==&#39;&#39;) $url = &#39;http://&#39;.$url;
 135              // 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.)
 136              if (empty($title) &amp;&amp; parse_url($url,PHP_URL_SCHEME)==&#39;http&#39;)
 137 @@ -1567,7 +1585,7 @@ function renderPage()
 138                      {
 139                          // Look for charset in html header.
 140                         preg_match(&#39;#&lt;meta .*charset=.*&gt;#Usi&#39;, $data, $meta);
 141 -
 142 +
 143                         // If found, extract encoding.
 144                         if (!empty($meta[0]))
 145                         {
 146 @@ -1577,7 +1595,7 @@ function renderPage()
 147                             $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : &#39;utf-8&#39;;
 148                         }
 149                         else { $html_charset = &#39;utf-8&#39;; }
 150 -
 151 +
 152                         // Extract title
 153                         $title = html_extract_title($data);
 154                         if (!empty($title))
 155 @@ -1592,7 +1610,7 @@ function renderPage()
 156                  $url=&#39;?&#39;.smallHash($linkdate);
 157                  $title=&#39;Note: &#39;;
 158              }
 159 -            $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);
 160 +            $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);
 161          }
 162
 163          $PAGE = new pageBuilder;
 164 @@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB)
 165          $taglist = explode(&#39; &#39;,$link[&#39;tags&#39;]);
 166          uasort($taglist, &#39;strcasecmp&#39;);
 167          $link[&#39;taglist&#39;]=$taglist;
 168 +        if(!empty($link[&#39;via&#39;])){
 169 +          $link[&#39;via&#39;]=htmlspecialchars($link[&#39;via&#39;]);
 170 +        }
 171          $linkDisp[$keys[$i]] = $link;
 172          $i++;
 173      }
 174 diff --git a/tpl/editlink.html b/tpl/editlink.html
 175 index 4a2c30c..14d4f9c 100644
 176 --- a/tpl/editlink.html
 177 +++ b/tpl/editlink.html
 178 @@ -16,6 +16,7 @@
 179             &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;
 180             &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;
 181             &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;
 182 +           &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;
 183             {if condition=&quot;($link_is_new &amp;&amp; $GLOBALS[&#39;privateLinkByDefault&#39;]==true) || $link.private == true&quot;}
 184              &lt;input type=&quot;checkbox&quot; checked=&quot;checked&quot; name=&quot;lf_private&quot; id=&quot;lf_private&quot;&gt;
 185              &amp;nbsp;&lt;label for=&quot;lf_private&quot;&gt;&lt;i&gt;Private&lt;/i&gt;&lt;/label&gt;&lt;br&gt;
 186 diff --git a/tpl/linklist.html b/tpl/linklist.html
 187 index ddc38cb..0a8475f 100644
 188 --- a/tpl/linklist.html
 189 +++ b/tpl/linklist.html
 190 @@ -43,6 +43,7 @@
 191                  &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;
 192                  &lt;br&gt;
 193                  {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}
 194 +                {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}
 195                  {if=&quot;!$GLOBALS[&#39;config&#39;][&#39;HIDE_TIMESTAMPS&#39;] || isLoggedIn()&quot;}
 196                      &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;
 197                  {else}
 198 --
 199 2.1.1</code></pre>
 200 </body>
 201 </html>