banana/misc.inc.php

   1 <?php
   2 /********************************************************************************
   3  * include/misc.inc.php : Misc functions
   4  * -------------------------
   5  *
   6  * This file is part of the banana distribution
   7  * Copyright: See COPYING files that comes with this distribution
   8  ********************************************************************************/
   9
  10 /********************************************************************************
  11  *  MISC
  12  */
  13
  14 function _b_($str) { return utf8_decode(dgettext('banana', utf8_encode($str))); }
  15
  16 function to_entities($str) {
  17     require_once dirname(__FILE__).'/utf8.php';
  18     return utf8entities(htmlentities($str, ENT_NOQUOTES, 'UTF-8'));
  19 }
  20
  21 function is_utf8($s) { return iconv('utf-8', 'utf-8', $s) == $s; }
  22
  23 function textFormat_translate($format)
  24 {
  25     switch (strtolower($format)) {
  26         case 'plain':       return _b_('Texte brut');
  27         case 'richtext':    return _b_('Texte enrichi');
  28         case 'html':        return _b_('HTML');
  29         default:            return $format;
  30     }
  31 }
  32
  33 /** Redirect to the page with the given parameter
  34  * @ref makeLink
  35  */
  36 function redirectInBanana($params)
  37 {
  38     header('Location: ' . makeLink($params));
  39 }
  40
  41 /** Make a link using the given parameters
  42  * @param ARRAY params, the parameters with
  43  *       key => value
  44  * Known key are:
  45  *  - group       = group name
  46  *  - artid/first = article id the the group
  47  *  - subscribe   = to show the subscription page
  48  *  - action      = action to do (new, cancel, view)
  49  *  - part        = to show the given MIME part of the article
  50  *  - pj          = to get the given attachment
  51  *  - xface       = to make a link to an xface
  52  *
  53  * Can be overloaded by defining a hook_makeLink function
  54  */
  55 function makeLink($params)
  56 {
  57     if (function_exists('hook_makeLink')
  58             && $res = hook_makeLink($params)) {
  59         return $res;
  60     }
  61     $proto = empty($_SERVER['HTTPS']) ? 'http://' : 'https://';
  62     $host  = $_SERVER['HTTP_HOST'];
  63     $file  = $_SERVER['PHP_SELF'];
  64
  65     if (isset($params['xface'])) {
  66         $file = dirname($file) . '/xface.php';
  67         $get  = 'face=' . urlencode(base64_encode($params['xface']));
  68     } else if (count($params) != 0) {
  69         $get = '?';
  70         foreach ($params as $key=>$value) {
  71             if (strlen($get) != 1) {
  72                 $get .= '&';
  73             }
  74             $get .= $key . '=' . $value;
  75         }
  76     } else {
  77         $get = '';
  78     }
  79
  80     return $proto . $host . $file . $get;
  81 }
  82
  83 /** Format a link to be use in a link
  84  * @ref makeLink
  85  */
  86 function makeHREF($params, $text = null, $popup = null, $class = null)
  87 {
  88     $link = makeLink($params);
  89     if (is_null($text)) {
  90         $text = $link;
  91     }
  92     if (!is_null($popup)) {
  93         $popup = ' title="' . $popup . '"';
  94     }
  95     if (!is_null($class)) {
  96         $class = ' class="' . $class . '"';
  97     }
  98     $target = null;
  99     if (isset($params['action']) && $params['action'] == 'view') {
 100         $target = ' target="_blank"';
 101     }
 102     return '<a href="' . htmlentities($link) .'"' . $target . $popup . $class . '>' . $text . '</a>';
 103 }
 104
 105 /** Format tree images links
 106  * @param img STRING Image name (without extension)
 107  * @param alt STRING alternative string
 108  * @param width INT  to force width of the image (null if not defined)
 109  *
 110  * This function can be overloaded by defining hook_makeImg()
 111  */
 112 function makeImg($img, $alt, $height = null, $width = null)
 113 {
 114     if (function_exists('hook_makeImg')
 115             && $res = hook_makeImg($img, $alt, $height, $width)) {
 116         return $res;
 117     }
 118
 119     if (!is_null($width)) {
 120         $width = ' width="' . $width . '"';
 121     }
 122     if (!is_null($height)) {
 123         $height = ' height="' . $height . '"';
 124     }
 125
 126     $proto = empty($_SERVER['HTTPS']) ? 'http://' : 'https://';
 127     $host  = $_SERVER['HTTP_HOST'];
 128     $file  = dirname($_SERVER['PHP_SELF']) . '/img/' . $img;
 129     $url   = $proto . $host . $file;
 130
 131     return '<img src="' . $url . '"' . $height . $width . ' alt="' . $alt . '" />';
 132 }
 133
 134 /** Make a link using an image
 135  */
 136 function makeImgLink($params, $img, $alt, $height = null, $width = null, $class = null)
 137 {
 138     return makeHREF($params,
 139                     makeImg($img, ' [' . $alt . ']', $height, $width),
 140                     $alt,
 141                     $class);
 142 }
 143
 144 /********************************************************************************
 145  * HTML STUFF
 146  * Taken from php.net
 147  */
 148
 149 /**
 150  * @return string
 151  * @param string
 152  * @desc Strip forbidden tags and delegate tag-source check to removeEvilAttributes()
 153  */
 154 function removeEvilTags($source)
 155 {
 156     $allowedTags = '<h1><b><i><a><ul><li><pre><hr><blockquote><img><br><font><p><small><big><sup><sub><code><em>';
 157     $source = preg_replace('|</div>|i', '<br />', $source);
 158     $source = strip_tags($source, $allowedTags);
 159     return preg_replace('/<(.*?)>/ie', "'<'.removeEvilAttributes('\\1').'>'", $source);
 160 }
 161
 162 /**
 163  * @return string
 164  * @param string
 165  * @desc Strip forbidden attributes from a tag
 166  */
 167 function removeEvilAttributes($tagSource)
 168 {
 169     $stripAttrib = 'javascript:|onclick|ondblclick|onmousedown|onmouseup|onmouseover|'.
 170                    'onmousemove|onmouseout|onkeypress|onkeydown|onkeyup';
 171     return stripslashes(preg_replace("/$stripAttrib/i", '', $tagSource));
 172 }
 173
 174 /** Convert html to plain text
 175  */
 176 function htmlToPlainText($res)
 177 {
 178     $res = trim(html_entity_decode(strip_tags($res, '<div><br><p>')));
 179     $res = preg_replace("@</?(br|p|div)[^>]*>@i", "\n", $res);
 180     if (!is_utf8($res)) {
 181         $res = utf8_encode($res);
 182     }
 183     return $res;
 184 }
 185
 186 /** Match **, // and __ to format plain text
 187  */
 188 function formatPlainText($text)
 189 {
 190     $formatting = Array('\*' => 'strong',
 191                         '_' => 'u',
 192                         '/' => 'em');
 193     foreach ($formatting as $limit=>$mark) {
 194         $text = preg_replace('@(^|\W)' . $limit . '(\w+)' . $limit . '(\W|$)@'
 195                             ,'\1<' . $mark . '>\2</' . $mark . '>\3'
 196                             , $text);
 197     }
 198     return $text;
 199 }
 200
 201 /********************************************************************************
 202  * RICHTEXT STUFF
 203  */
 204
 205 /** Convert richtext to html
 206  */
 207 function richtextToHtml($source)
 208 {
 209     $tags = Array('bold' => 'b',
 210                   'italic' => 'i',
 211                   'smaller' => 'small',
 212                   'bigger' => 'big',
 213                   'underline' => 'u',
 214                   'subscript' => 'sub',
 215                   'superscript' => 'sup',
 216                   'excerpt' => 'blockquote',
 217                   'paragraph' => 'p',
 218                   'nl' => 'br'
 219             );
 220
 221     // clean unsupported tags
 222     $protectedTags = '<signature><lt><comment><'.join('><', array_keys($tags)).'>';
 223     $source = strip_tags($source, $protectedTags);
 224
 225     // convert richtext tags to html
 226     foreach (array_keys($tags) as $tag) {
 227         $source = preg_replace('@(</?)'.$tag.'([^>]*>)@i', '\1'.$tags[$tag].'\2', $source);
 228     }
 229
 230     // some special cases
 231     $source = preg_replace('@<signature>@i', '<br>-- <br>', $source);
 232     $source = preg_replace('@</signature>@i', '', $source);
 233     $source = preg_replace('@<lt>@i', '&lt;', $source);
 234     $source = preg_replace('@<comment[^>]*>((?:[^<]|<(?!/comment>))*)</comment>@i', '<!-- \1 -->', $source);
 235     return removeEvilAttributes($source);
 236 }
 237
 238 /********************************************************************************
 239  *  HEADER STUFF
 240  */
 241
 242 function _headerdecode($charset, $c, $str) {
 243     $s = ($c == 'Q' || $c == 'q') ? quoted_printable_decode($str) : base64_decode($str);
 244     $s = iconv($charset, 'iso-8859-15', $s);
 245     return str_replace('_', ' ', $s);
 246 }
 247
 248 function headerDecode($value) {
 249     $val = preg_replace('/(=\?[^?]*\?[BQbq]\?[^?]*\?=) (=\?[^?]*\?[BQbq]\?[^?]*\?=)/', '\1\2', $value);
 250     return preg_replace('/=\?([^?]*)\?([BQbq])\?([^?]*)\?=/e', '_headerdecode("\1", "\2", "\3")', $val);
 251 }
 252
 253 function headerEncode($value, $trim = 0) {
 254     if ($trim) {
 255         if (strlen($value) > $trim) {
 256             $value = substr($value, 0, $trim) . "[...]";
 257         }
 258     }
 259     return "=?UTF-8?B?".base64_encode($value)."?=";
 260 }
 261
 262 function header_translate($hdr) {
 263     switch ($hdr) {
 264         case 'from':            return _b_('De');
 265         case 'subject':         return _b_('Sujet');
 266         case 'newsgroups':      return _b_('Forums');
 267         case 'followup-to':     return _b_('Suivi-à');
 268         case 'date':            return _b_('Date');
 269         case 'organization':    return _b_('Organisation');
 270         case 'references':      return _b_('Références');
 271         case 'x-face':          return _b_('Image');
 272         default:
 273             if (function_exists('hook_headerTranslate')
 274                     && $res = hook_headerTranslate($hdr)) {
 275                 return $res;
 276             }
 277             return $hdr;
 278     }
 279 }
 280
 281 function formatDisplayHeader($_header,$_text) {
 282     global $banana;
 283     if (function_exists('hook_formatDisplayHeader')
 284             && $res = hook_formatDisplayHeader($_header, $_text)) {
 285         return $res;
 286     }
 287
 288     switch ($_header) {
 289         case "date":
 290             return formatDate($_text);
 291
 292         case "followup-to":
 293             case "newsgroups":
 294             $res = "";
 295             $groups = preg_split("/[\t ]*,[\t ]*/",$_text);
 296             foreach ($groups as $g) {
 297                 $res .= makeHREF(Array('group' => $g), $g) . ', ';
 298             }
 299             return substr($res,0, -2);
 300
 301         case "from":
 302             return formatFrom($_text);
 303
 304         case "references":
 305             $rsl     = "";
 306             $ndx     = 1;
 307             $text    = str_replace("><","> <",$_text);
 308             $text    = preg_split("/[ \t]/",strtr($text,$banana->spool->ids));
 309             $parents = preg_grep("/^\d+$/",$text);
 310             $p       = array_pop($parents);
 311             $par_ok  = Array();
 312
 313             while ($p) {
 314                 $par_ok[]=$p;
 315                 $p = $banana->spool->overview[$p]->parent;
 316             }
 317             foreach (array_reverse($par_ok) as $p) {
 318                 $rsl .= makeHREF(Array('group' => $banana->spool->group,
 319                                        'artid' => $p),
 320                                  $ndx) . ' ';
 321                 $ndx++;
 322             }
 323             return $rsl;
 324
 325         case "x-face":
 326             return '<img src="' . makeLink(Array('xface' => headerDecode($_text))) .'"  alt="x-face" />';
 327
 328         case "subject":
 329             $link = null;
 330             if (function_exists('hook_getSubject')) {
 331                 $link = hook_getSubject($_text);
 332             }
 333             return formatPlainText($_text) . $link;
 334
 335         default:
 336             return htmlentities($_text);
 337     }
 338 }
 339
 340 /********************************************************************************
 341  *  FORMATTING STUFF
 342  */
 343
 344 function formatDate($_text) {
 345     return strftime("%A %d %B %Y, %H:%M (fuseau serveur)", strtotime($_text));
 346 }
 347
 348 function fancyDate($stamp) {
 349     $today  = intval(time() / (24*3600));
 350     $dday   = intval($stamp / (24*3600));
 351
 352     if ($today == $dday) {
 353         $format = "%H:%M";
 354     } elseif ($today == 1 + $dday) {
 355         $format = _b_('hier')." %H:%M";
 356     } elseif ($today < 7 + $dday) {
 357         $format = '%a %H:%M';
 358     } else {
 359         $format = '%a %e %b';
 360     }
 361     return strftime($format, $stamp);
 362 }
 363
 364 function formatFrom($text) {
 365 #     From: mark@cbosgd.ATT.COM
 366 #     From: mark@cbosgd.ATT.COM (Mark Horton)
 367 #     From: Mark Horton <mark@cbosgd.ATT.COM>
 368     $mailto = '<a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;';
 369
 370     $result = htmlentities($text);
 371     if (preg_match("/^([^ ]+)@([^ ]+)$/",$text,$regs)) {
 372         $result="$mailto{$regs[1]}&#64;{$regs[2]}\">".htmlentities($regs[1]."&#64;".$regs[2])."</a>";
 373     }
 374     if (preg_match("/^([^ ]+)@([^ ]+) \((.*)\)$/",$text,$regs)) {
 375         $result="$mailto{$regs[1]}&#64;{$regs[2]}\">".htmlentities($regs[3])."</a>";
 376     }
 377     if (preg_match("/^\"?([^<>\"]+)\"? +<(.+)@(.+)>$/",$text,$regs)) {
 378         $result="$mailto{$regs[2]}&#64;{$regs[3]}\">".htmlentities($regs[1])."</a>";
 379     }
 380     return preg_replace("/\\\(\(|\))/","\\1",$result);
 381 }
 382
 383 function makeTab($link, $text)
 384 {
 385     return Array(makeHREF($link, $text),
 386                  $text);
 387 }
 388
 389 function displayTabs()
 390 {
 391     global $banana;
 392     extract($banana->state);
 393     if (function_exists('hook_shortcuts') && $cstm = hook_shortcuts()) {
 394         $res = $cstm;
 395     }
 396
 397     $res['subscribe'] = makeTab(Array('subscribe' => 1), _b_('Abonnements'));
 398     $res['forums']    = makeTab(Array(), _b_('Les forums'));
 399
 400     if (!is_null($group)) {
 401         $res['group'] = makeTab(Array('group' => $group), $group);
 402         if (is_null($artid)) {
 403             if (@$action == 'new') {
 404                 $res['action'] = makeTab(Array('group'  => $group,
 405                                                'action' => 'new'),
 406                                          _b_('Nouveau Message'));
 407             }
 408         } else {
 409             $res['message'] = makeTab(Array('group' => $group,
 410                                             'artid' => $artid),
 411                                       _b_('Message'));
 412             if (!is_null($action)) {
 413                 if ($action == 'new') {
 414                     $res['action'] = makeTab(Array('group'  => $group,
 415                                                    'artid'  => $artid,
 416                                                    'action' => 'new'),
 417                                              _b_('Réponse'));
 418                 } elseif ($action == 'cancel') {
 419                     $res['action'] = makeTab(Array('group'  => $group,
 420                                                    'artid'  => $artid,
 421                                                    'action' => 'cancel'),
 422                                              _b_('Annuler'));
 423                 }
 424             }
 425         }
 426     }
 427     $ret = '<ul id="onglet">';
 428     foreach ($res as $name=>$onglet) {
 429         if ($name != @$page) {
 430             $ret .= '<li>' . $onglet[0] . '</li>';
 431         } else {
 432             $ret .= '<li class="actif">' . $onglet[1] . '</li>';
 433         }
 434     }
 435     $ret .= '</ul>';
 436     return $ret;
 437 }
 438
 439 function displayPages($first = -1)
 440 {
 441     global $banana;
 442     extract($banana->state);
 443     $res = null;
 444     if (!is_null($group) && is_null($artid)
 445             && sizeof($banana->spool->overview)>$banana->tmax) {
 446         $res .= '<div class="pages">';
 447         $n = intval(log(count($banana->spool->overview), 10))+1;
 448         $i = 1;
 449         for ($ndx = 1 ; $ndx <= sizeof($banana->spool->overview) ; $ndx += $banana->tmax) {
 450             if ($first==$ndx) {
 451                 $res .= '<strong>' . $i . '</strong> ';
 452             } else {
 453                 $res .= makeHREF(Array('group' => $group,
 454                                        'first' => $ndx),
 455                                  $i,
 456                                  $ndx . '-' . min($ndx+$banana->tmax-1,sizeof($banana->spool->overview)))
 457                      . ' ';
 458             }
 459             $i++;
 460         }
 461         $res .= '</div>';
 462     }
 463     return $res;
 464 }
 465
 466 function makeTable($text)
 467 {
 468     $links = null;
 469     if (function_exists('hook_browsingAction')) {
 470         $links = hook_browsingAction();
 471     }
 472
 473     return '<table class="cadre_a_onglet" cellpadding="0" cellspacing="0" width="100%">'
 474          . '<tr><td>'
 475          . displayTabs()
 476          . '</td></tr>'
 477          . '<tr><td class="conteneur_tab">'
 478          . $links
 479          . $text
 480          . '</td></tr>'
 481          . '</table>';
 482 }
 483
 484 /********************************************************************************
 485  *  FORMATTING STUFF : BODY
 486  */
 487
 488 function autoformat($text, $force = 0)
 489 {
 490     global $banana;
 491     $length = $banana->wrap;
 492     $force  = $force ? 1 : 0;
 493     $cmd = 'echo ' . escapeshellarg($text)
 494          . ' | perl -MText::Autoformat -e \'autoformat {left=>1, right=>' . $length . ', all=>' . $force . ' };\'';
 495
 496     exec($cmd, $result, $ret);
 497     if ($ret != 0) {
 498         $result = split("\n", $text);
 499     }
 500     return $result;
 501 }
 502
 503 function wrap($text, $_prefix="", $_force=false, $firstpass = true)
 504 {
 505     $parts = preg_split("/\n-- ?\n/", $text);
 506     if (count($parts)  >1) {
 507         $sign = "\n-- \n" . array_pop($parts);
 508         $text = join("\n-- \n", $parts);
 509     } else {
 510         $sign = '';
 511     }
 512
 513     global $banana;
 514     $url    = $banana->url_regexp;
 515     $length = $banana->wrap;
 516     $max    = $length + ($length/10);
 517     $splits = split("\n", $text);
 518     $result = array();
 519     $next   = array();
 520     $format = false;
 521     foreach ($splits as $line) {
 522         if ($_force || strlen($line) > $max) {
 523             if (preg_match("!^(.*)($url)(.*)!i", $line, $matches)
 524                     && strlen($matches[2]) > $length && strlen($matches) < 900) {
 525                 if (strlen($matches[1]) != 0) {
 526                     array_push($next, rtrim($matches[1]));
 527                     if (strlen($matches[1]) > $max) {
 528                         $format = true;
 529                     }
 530                 }
 531
 532                 if ($format) {
 533                     $result = array_merge($result, autoformat(join("\n", $next), $firstpass));
 534                 } else {
 535                     $result = array_merge($result, $next);
 536                 }
 537                 $format = false;
 538                 $next   = array();
 539                 array_push($result, $matches[2]);
 540
 541                 if (strlen($matches[6]) != 0) {
 542                     array_push($next, ltrim($matches[6]));
 543                     if (strlen($matches[6]) > $max) {
 544                         $format = true;
 545                     }
 546                 }
 547             } else {
 548                 array_push($next, $line);
 549                 $format = true;
 550             }
 551         } else {
 552             array_push($next, $line);
 553         }
 554     }
 555     if ($format) {
 556         $result = array_merge($result, autoformat(join("\n", $next), $firstpass));
 557     } else {
 558         $result = array_merge($result, $next);
 559     }
 560
 561     $break = "\n";
 562     $prefix = null;
 563     if (!$firstpass) {
 564         $break .= $_prefix;
 565         $prefix = $_prefix;
 566     }
 567     $result = $prefix.join($break, $result).($prefix ? '' : $sign);
 568     if ($firstpass) {
 569         return wrap($result, $_prefix, $_force, false);
 570     }
 571     return $result;
 572 }
 573
 574 function cutlink($link)
 575 {
 576     global $banana;
 577
 578     if (strlen($link) > $banana->wrap) {
 579         $link = substr($link, 0, $banana->wrap - 3)."...";
 580     }
 581     return $link;
 582 }
 583
 584 function cleanurl($url)
 585 {
 586     $url = str_replace('@', '%40', $url);
 587     return '<a href="'.$url.'" title="'.$url.'">'.cutlink($url).'</a>';
 588 }
 589
 590 function catchMailLink($email)
 591 {
 592     global $banana;
 593     $mid = '<' . $email . '>';
 594     if (isset($banana->spool->ids[$mid])) {
 595         return makeHREF(Array('group' => $banana->state['group'],
 596                               'artid' => $banana->spool->ids[$mid]),
 597                         $email);
 598     } elseif (strpos($email, '$') !== false) {
 599         return $email;
 600     }
 601     return '<a href="mailto:' . $email . '">' . $email . '</a>';
 602 }
 603
 604 /** Remove quotation marks
 605  */
 606 function replaceQuotes($text)
 607 {
 608     return stripslashes(preg_replace("@(^|<pre>|\n)&gt;[ \t\r]*@i", '\1', $text));
 609 }
 610
 611 function formatbody($_text, $format='plain', $flowed=false)
 612 {
 613     if ($format == 'html') {
 614         $res = html_entity_decode(to_entities(removeEvilTags($_text)));
 615     } else if ($format == 'richtext') {
 616         $res = html_entity_decode(to_entities(richtextToHtml($_text)));
 617     } else {
 618         $res  = to_entities(wrap($_text, "", $flowed));
 619         $res  = formatPlainText($res);
 620     }
 621
 622     if ($format != 'html') {
 623         global $banana;
 624         $url  = $banana->url_regexp;
 625         $res  = preg_replace("/(&lt;|&gt;|&quot;)/", " \\1 ", $res);
 626         $res  = preg_replace("!$url!ie", "'\\1'.cleanurl('\\2').'\\3'", $res);
 627         $res  = preg_replace('/(["\[])?(?:mailto:|news:)?([a-z0-9.\-+_\$]+@([\-.+_]?[a-z0-9])+)(["\]])?/ie',
 628                              "'\\1' . catchMailLink('\\2') . '\\4'",
 629                              $res);
 630         $res  = preg_replace("/ (&lt;|&gt;|&quot;) /", "\\1", $res);
 631
 632         if ($format == 'richtext') {
 633             $format = 'html';
 634         }
 635     }
 636
 637     if ($format == 'html') {
 638         $res = preg_replace("@(</p>)\n?-- ?\n?(<p[^>]*>|<br[^>]*>)@", "\\1<br/>-- \\2", $res);
 639         $res = preg_replace("@<br[^>]*>\n?-- ?\n?(<p[^>]*>)@", "<br/>-- <br/>\\2", $res);
 640         $res = preg_replace("@(<pre[^>]*>)\n?-- ?\n@", "<br/>-- <br/>\\1", $res);
 641         $parts = preg_split("@(:?<p[^>]*>\n?-- ?\n?</p>|<br[^>]*>\n?-- ?\n?<br[^>]*>)@", $res);
 642         $sign  = '<hr style="width: 100%; margin: 1em 0em; " />';
 643     } else {
 644         while (preg_match("@(^|<pre>|\n)&gt;@i", $res)) {
 645             $res  = preg_replace("@(^|<pre>|\n)((&gt;[^\n]*(?:\n|$))+)@ie",
 646                 "'\\1</pre><blockquote><pre>'"
 647                 ." . replaceQuotes('\\2')"
 648                 ." . '</pre></blockquote><pre>'",
 649                 $res);
 650         }
 651         $res = preg_replace("@<pre>-- ?\n@", "<pre>\n-- \n", $res);
 652         $parts = preg_split("/\n-- ?\n/", $res);
 653         $sign  = '</pre><hr style="width: 100%; margin: 1em 0em; " /><pre>';
 654     }
 655
 656     return join($sign, $parts);
 657 }
 658
 659 // vim:set et sw=4 sts=4 ts=4
 660 ?>