encode.php

   1 <?php
   2
   3 #  Copyright (C) 2005 Jason Woofenden
   4 #
   5 #  This program is free software: you can redistribute it and/or modify
   6 #  it under the terms of the GNU General Public License as published by
   7 #  the Free Software Foundation, either version 3 of the License, or
   8 #  (at your option) any later version.
   9 #
  10 #  This program is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #  GNU General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU General Public License
  16 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18
  19 # This file contains basic encodings. These are used by the encoder. You can
  20 # specify any template tag to be encoded with this syntax: ~variable encoding~
  21 #
  22 # this example: <p>~foo html~</p>
  23 # will encode foo (using enc_html()) before displaying it, so that characters
  24 # such as < will display properly.
  25
  26 function enc_cap($str) {
  27         $str = ucfirst($str);
  28         return $str;
  29 }
  30
  31 function enc_jsdq($str) {
  32         $str = enc_sql($str);
  33         $str = str_replace("\n", "\\n", $str);
  34         return str_replace("\r", "\\r", $str);
  35 }
  36
  37 # encode for putting within double-quotes in SQL
  38 function enc_sql($str) {
  39         $str = str_replace("\\", "\\\\", $str);
  40         $str = str_replace('"', "\\\"", $str);
  41         return $str;
  42 }
  43
  44 # Encode for output in html. does nothing with whitespace
  45 #
  46 # Example: <p>~foo html~</p>
  47 function enc_html($str) {
  48         $str = str_replace('&', '&amp;', $str);
  49         $str = str_replace('<', '&lt;', $str);
  50         $str = str_replace('>', '&gt;', $str);
  51         return $str;
  52 }
  53
  54 # Encode for output in html. Convert newlines to <br>
  55 #
  56 # Example: <p>~foo htmlbr~</p>
  57 function enc_htmlbr($str) {
  58         $str = enc_html($str);
  59         $str = str_replace("\n", "<br>\n", $str);
  60         return $str;
  61 }
  62
  63 # Encode for output in html. Preserves newlines and indentation by converting
  64 # newlines to <br> and spaces at the begining of lines to &nbsp;&nbsp;
  65 #
  66 # Example: <p>~foo htmlbrtab~</p>
  67 function enc_htmlbrtab($str) {
  68         $str = enc_htmlbr($str);
  69         $space_to_nbsp = create_function('$matches', 'return str_repeat(\'&nbsp;\', strlen($matches[0]) * 2);');
  70         $str = preg_replace_callback("|^ *|m", $space_to_nbsp, $str);
  71         return $str;
  72 }
  73
  74 # Encode for output in html. Spaces converted to &nbsp; and \n to <br>
  75 #
  76 # Example: <option value="12">~foo htmlbrnbsp~</option>
  77 function enc_htmlbrnbsp($str) {
  78         $str = enc_htmlbr($str);
  79         $str = str_replace(' ', '&nbsp;', $str);
  80         return $str;
  81 }
  82
  83 # Encode for output in html. Spaces converted to &nbsp;
  84 #
  85 # Example: <option value="12">~foo htmlnbsp~</option>
  86 function enc_htmlnbsp($str) {
  87         $str = enc_html($str);
  88         $str = str_replace(' ', '&nbsp;', $str);
  89         return $str;
  90 }
  91
  92
  93 # HTML attribute.
  94 #
  95 # Example: <input name="foo" value="~foo attr~">
  96 function enc_attr($str) {
  97         $str = str_replace('&', '&amp;', $str);
  98         $str = str_replace('"', '&quot;', $str);
  99         return $str;
 100 }
 101
 102 # URI agument value.
 103 #
 104 # Example:  <a href="http://example.com?foo=~foo url_val attr~">http://example.com?foo=~foo url_val~</a>
 105 function enc_url_val($str) {
 106         return rawurlencode($str);
 107 }
 108
 109 # FIXME
 110 function enc_url_path($str) {
 111         $str = rawurlencode($str);
 112         $str = str_replace('%2F', '/', $str);
 113         return $str;
 114 }
 115
 116
 117 # This is a hack to work around html's stupid syntax for checkboxes.
 118 #
 119 # Place the template marker just before a " somewhere.
 120 #
 121 # Example: <input type="checkbox" name="foo~foo checked~">
 122 function enc_checked($str) {
 123         if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
 124                 return '" checked="checked';
 125         } else {
 126                 return '';
 127         }
 128 }
 129
 130 # normally, checkboxes values from get/post to 0 or 1, and stored in the database this way. enc_yesno() can be used in your templates to display this as "Yes" or "No".
 131 # Example template:  Subscribe to mailing list?: ~subscribe yesno~
 132 function enc_yesno($str) {
 133         if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
 134                 return 'Yes';
 135         } else {
 136                 return 'No';
 137         }
 138 }
 139
 140
 141 # add a tab at the begining of each line
 142 function enc_tab($str) {
 143         if('' . $str === '') {
 144                 return '';
 145         }
 146         return "\t" . implode("\n\t", explode("\n", $str));
 147 }
 148
 149 function enc_uppercase($str) {
 150         return strtoupper($str);
 151 }
 152 function enc_upper($str) { # depricated
 153         return enc_uppercase($str);
 154 }
 155
 156 function enc_lowercase($str) {
 157         return strtolower($str);
 158 }
 159
 160 # pass date in the form 2008-05-23
 161 # ercodes date as 05/23/2008
 162 function enc_mmddyyyy($yyyy_mm_dd) {
 163         if($yyyy_mm_dd == '') {
 164                 return '';
 165         }
 166         if(strlen($yyyy_mm_dd) != 10) {
 167                 return date('m/d/Y');
 168         }
 169         return substr($yyyy_mm_dd, 5, 2) . '/' . substr($yyyy_mm_dd, 8, 2) . '/' . substr($yyyy_mm_dd, 0, 4);
 170 }
 171
 172 # depricated. call enc_mmddyyyy() instead
 173 function enc_mdy($str) {
 174         return enc_mmddyyyy($str);
 175 }
 176
 177 # pass unix timestamp or "2012-12-20 22:23:34"
 178 function enc_mmddyyyyhhmm($str) {
 179         if(is_numeric($str)) {
 180                 return date('m/d/Y g:ia', (int)$str);
 181         } else {
 182                 return enc_mmddyyyy(substr($str, 0, 10)) . substr($str, 10, 6);
 183         }
 184 }
 185
 186 # takes decimal number of hours
 187 # returns hh:mm
 188 function enc_hhmm($str) {
 189         if(strlen($str) == 0) {
 190                 return '';
 191         }
 192         $hours = floor($str);
 193         $minutes = round(($str - $hours) * 60);
 194         $str = sprintf("%d:%02d", $hours, $minutes);
 195         return $str;
 196 }
 197
 198 # takes decimal number of hours
 199 # returns hh:mm followed by "am" or "pm" with no space
 200 function enc_12hr($str) {
 201         if(strlen($str) == 0) {
 202                 return '';
 203         }
 204         $hours = floor($str);
 205         $minutes = round(($str - $hours) * 60);
 206         $suffix = 'am';
 207         if($hours >= 12.0) {
 208                 $suffix = 'pm';
 209                 if($hours > 12.0) {
 210                         $hours -= 12.0;
 211                 }
 212         }
 213         $str = sprintf("%d:%02d", $hours, $minutes);
 214         $str .= $suffix;
 215         return $str;
 216 }
 217
 218
 219
 220 # These are depricated! All but PULLDOWN_HASH still work, but you should update your code.
 221 define('PULLDOWN_AUTO', 0); define('PULLDOWN_ARRAY', 1); define('PULLDOWN_HASH', 2); define('PULLDOWN_2D', 3);
 222
 223
 224 # call this function before you run() the template so enc_options() knows what
 225 # to do
 226 #
 227 # Parameters:
 228 #
 229 #   name: the name of the html control
 230 #
 231 #   options: an array of options to display in the pulldown/selectbox. Each
 232 #   element can be either a string, or an array with two elements (first the
 233 #   value to post, and second the value to display in the pulldown)
 234 #
 235 #   multiple: UNTESTED set to true for multiple-select boxes.
 236
 237 function pulldown($name, $in_options, $multiple = false) {
 238         if($multiple === PULLDOWN_HASH) {
 239                 die('Webmaster error: PULLDOWN_HASH is depricated. Pass array(a,b) not a=>b');
 240         }
 241         if($multiple !== true) {
 242                 # Probably due to API change (removing 3rd argument) but don't bother
 243                 # emitting a warning, because the above warning handles the only
 244                 # important case.
 245                 $multiple = false;
 246         }
 247         $options = array();
 248         foreach($in_options as $option) {
 249                 if(is_array($option)) {
 250                         $options[] = $option;
 251                 } else {
 252                         $options[] = array($option, $option);
 253                 }
 254         }
 255         $GLOBALS[$name . '_options'] = array(
 256                 'options' => $options,
 257                 'multiple' => $multiple);
 258 }
 259
 260 # output a bunch of <option> tags
 261 function enc_options($values, $name) {
 262         if(!isset($GLOBALS[$name . '_options'])) {
 263                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 264         }
 265         if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
 266                 $values = explode(', ', $values);
 267         }
 268         return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_2D);
 269 }
 270
 271 # for radios and pulldowns:
 272 # pass posted value
 273 # returns what the user sees in the pulldown or on the radio button caption
 274 function enc_pulled($str, $name) {
 275         if(!isset($GLOBALS[$name . '_options'])) {
 276                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 277         }
 278         foreach($GLOBALS[$name . '_options']['options'] as &$kv) {
 279                 if($kv[0] == $str) {
 280                         return $kv[1];
 281                 }
 282         }
 283         return $str;
 284 }
 285
 286 function enc_radio_n($str, $name, $n) {
 287         if(!isset($GLOBALS[$name . '_options'])) {
 288                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 289         }
 290
 291         if(!isset($GLOBALS[$name . '_options']['options'][$n])) {
 292                 die("Template error: pulldown('$name') does not have element # $n");
 293         }
 294
 295         $value = enc_attr($GLOBALS[$name . '_options']['options'][$n][0]);
 296
 297         if($str === $value) {
 298                 $value .= '" checked="checked';
 299         }
 300
 301         return $value;
 302 }
 303 function enc_radio_0($str, $name) { return enc_radio_n($str, $name, 0); }
 304 function enc_radio_1($str, $name) { return enc_radio_n($str, $name, 1); }
 305 function enc_radio_2($str, $name) { return enc_radio_n($str, $name, 2); }
 306 function enc_radio_3($str, $name) { return enc_radio_n($str, $name, 3); }
 307 function enc_radio_4($str, $name) { return enc_radio_n($str, $name, 4); }
 308 function enc_radio_5($str, $name) { return enc_radio_n($str, $name, 5); }
 309 function enc_radio_6($str, $name) { return enc_radio_n($str, $name, 6); }
 310 function enc_radio_7($str, $name) { return enc_radio_n($str, $name, 7); }
 311
 312
 313 function enc_radio_caption_n($str, $name, $n) {
 314         if(!isset($GLOBALS[$name . '_options'])) {
 315                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 316         }
 317
 318         if(!isset($GLOBALS[$name . '_options']['options'][$n])) {
 319                 die("Template error: pulldown('$name') does not have element #$n");
 320         }
 321
 322         return $GLOBALS[$name . '_options']['options'][$n][1];
 323 }
 324 function enc_radio_caption_0($str, $name) { return enc_radio_caption_n($str, $name, 0); }
 325 function enc_radio_caption_1($str, $name) { return enc_radio_caption_n($str, $name, 1); }
 326 function enc_radio_caption_2($str, $name) { return enc_radio_caption_n($str, $name, 2); }
 327 function enc_radio_caption_3($str, $name) { return enc_radio_caption_n($str, $name, 3); }
 328 function enc_radio_caption_4($str, $name) { return enc_radio_caption_n($str, $name, 4); }
 329 function enc_radio_caption_5($str, $name) { return enc_radio_caption_n($str, $name, 5); }
 330 function enc_radio_caption_6($str, $name) { return enc_radio_caption_n($str, $name, 6); }
 331 function enc_radio_caption_7($str, $name) { return enc_radio_caption_n($str, $name, 7); }
 332
 333
 334 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
 335 #
 336 # Parameters:
 337 #
 338 #    selected: can be a string or (for multiple-selects) an array
 339 #
 340 #    options, keys_from: see documentation for pulldown() above
 341 function encode_options($selected, $options, $keys_from) {
 342         if(!is_array($selected)) {
 343                 $selected = array($selected);
 344         }
 345
 346         if($keys_from != PULLDOWN_2D) {
 347                 $options = pulldown_options_to_2d($options, $keys_from);
 348         }
 349
 350         $out = '';
 351         foreach($options as $option) {
 352                 list($value, $display, $arg3) = $option;
 353                 $out .= '<option';
 354
 355                 if($arg3 == 'disabled') {
 356                         $out .= ' disabled';
 357                 } elseif(in_array($value, $selected)) {
 358                         $out .= ' selected';
 359                 }
 360
 361                 if($value !== $display || strpos($value, ' ') !== false) {
 362                         $out .= ' value="';
 363                         $out .= enc_attr($value);
 364                         $out .= '"';
 365                 }
 366
 367                 $out .= '>';
 368
 369                 $out .= enc_htmlnbsp($display);
 370
 371                 $out .= "</option>\n";
 372         }
 373
 374         return $out;
 375 }
 376
 377 $GLOBALS['wfpl_states_assoc'] = array("AL" => "Alabama", "AK" => "Alaska", "AZ" => "Arizona", "AR" => "Arkansas", "CA" => "California", "CO" => "Colorado", "CT" => "Connecticut", "DE" => "Delaware", "FL" => "Florida", "GA" => "Georgia", "HI" => "Hawaii", "ID" => "Idaho", "IL" => "Illinois", "IN" => "Indiana", "IA" => "Iowa", "KS" => "Kansas", "KY" => "Kentucky", "LA" => "Louisiana", "ME" => "Maine", "MD" => "Maryland", "MA" => "Massachusetts", "MI" => "Michigan", "MN" => "Minnesota", "MS" => "Mississippi", "MO" => "Missouri", "MT" => "Montana", "NE" => "Nebraska", "NV" => "Nevada", "NH" => "New Hampshire", "NJ" => "New Jersey", "NM" => "New Mexico", "NY" => "New York", "NC" => "North Carolina", "ND" => "North Dakota", "OH" => "Ohio", "OK" => "Oklahoma", "OR" => "Oregon", "PA" => "Pennsylvania", "RI" => "Rhode Island", "SC" => "South Carolina", "SD" => "South Dakota", "TN" => "Tennessee", "TX" => "Texas", "UT" => "Utah", "VT" => "Vermont", "VA" => "Virginia", "WA" => "Washington", "DC" => "Washington, DC", "WV" => "West Virginia", "WI" => "Wisconsin", "WY" => "Wyoming");
 378
 379 # display <option>s
 380 function enc_states($str) {
 381         $ret = '';
 382
 383         return encode_options($str, $GLOBALS['wfpl_states_assoc'], PULLDOWN_HASH);
 384 }
 385
 386 $GLOBALS['wfpl_provinces_assoc'] = array("AB" => "Alberta", "BC" => "British Columbia", "MB" => "Manitoba", "NF" => "Newfoundland", "NB" => "New Brunswick", "NS" => "Nova Scotia", "NT" => "Northwest Territories", "NU" => "Nunavut", "ON" => "Ontario", "PE" => "Prince Edward Island", "QC" => "Quebec", "SK" => "Saskatchewan", "YT" => "Yukon Territory");
 387
 388 # display <option>s
 389 function enc_provinces($str) {
 390         $ret = '';
 391
 392         return encode_options($str, $GLOBALS['wfpl_provinces_assoc'], PULLDOWN_HASH);
 393 }
 394
 395 # returns "odd", then "even", then "odd" etc.
 396 function enc_evenodd($values, $name) {
 397         if(!isset($GLOBALS['wfpl_even_odds'])) {
 398                 $GLOBALS['wfpl_even_odds'] = array();
 399         }
 400
 401         if($GLOBALS['wfpl_even_odds'][$name]) {
 402                 $GLOBALS['wfpl_even_odds'][$name] = false;
 403                 return 'even';
 404         } else {
 405                 $GLOBALS['wfpl_even_odds'][$name] = true;
 406                 return 'odd';
 407         }
 408 }
 409
 410 function enc_image_src($str) {
 411         list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
 412         return $src;
 413 }
 414
 415 function enc_image_width($str) {
 416         list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
 417         return $width;
 418 }
 419
 420 function enc_image_height($str) {
 421         list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
 422         return $height;
 423 }
 424
 425 function enc_thumb_src($str) {
 426         list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
 427         return $src;
 428 }
 429
 430 function enc_thumb_width($str) {
 431         list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
 432         return $width;
 433 }
 434 function enc_thumb_height($str) {
 435         list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
 436         return $height;
 437 }
 438
 439 # example template: Length: ~length html~ day~length s~
 440 function enc_s($str) {
 441         if($str == '1') {
 442                 return '';
 443         }
 444
 445         return 's';
 446 }
 447
 448 # turn http/ftp (s) urls into html links (and encode everything for html)
 449 # does not encode without protocol (eg "www.foo.com")
 450 # does not linkify email addresses
 451 function enc_linkify($str) {
 452         $ret = '';
 453         $even = true;
 454         $pieces = preg_split("/((?:ht|f)tps?:\/\/[^ \,\"\n\r\t<]+)/is", $str, null, PREG_SPLIT_DELIM_CAPTURE);
 455         foreach($pieces as $piece) {
 456                 if($even) {
 457                         $ret .= enc_html($piece);
 458                 } else {
 459                         $ret .= '<a href="' . enc_attr($piece) . '">' . enc_html($piece) . '</a>';
 460                 }
 461                 $even = !$even;
 462         }
 463         return $ret;
 464 }
 465
 466 # turns a filename into the unix timestamp of that files modification date
 467 function enc_mtime($dummy, $filename) {
 468         $stat = stat($filename);
 469         if ($stat === false) {
 470                 return '';
 471         }
 472         return '' . $stat['mtime'];
 473 }