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_upper($str) {
 150         return strtoupper($str);
 151 }
 152
 153 # pass date in the form 2008-05-23
 154 # ercodes date as 05/23/2008
 155 function enc_mmddyyyy($yyyy_mm_dd) {
 156         if($yyyy_mm_dd == '') {
 157                 return '';
 158         }
 159         if(strlen($yyyy_mm_dd) != 10) {
 160                 return date('m/d/Y');
 161         }
 162         return substr($yyyy_mm_dd, 5, 2) . '/' . substr($yyyy_mm_dd, 8, 2) . '/' . substr($yyyy_mm_dd, 0, 4);
 163 }
 164
 165 # depricated. call enc_mmddyyyy() instead
 166 function enc_mdy($str) {
 167         return enc_mmddyyyy($str);
 168 }
 169
 170 function enc_mmddyyyyhhmm($seconds) {
 171         return date('m/d/Y g:ia', (int)$seconds);
 172 }
 173
 174 # takes decimal
 175 # returns hh:mm
 176 function enc_hhmm($str) {
 177         if(strlen($str) == 0) {
 178                 return '';
 179         }
 180         $hours = floor($str);
 181         $minutes = round(($str - $hours) * 60);
 182         $str = sprintf("%d:%02d", $hours, $minutes);
 183         return $str;
 184 }
 185
 186 # takes decimal
 187 # returns hh:mm followed by "am" or "pm" with no space
 188 function enc_12hr($str) {
 189         if(strlen($str) == 0) {
 190                 return '';
 191         }
 192         $hours = floor($str);
 193         $minutes = round(($str - $hours) * 60);
 194         $suffix = 'am';
 195         if($hours >= 12.0) {
 196                 $suffix = 'pm';
 197                 if($hours > 12.0) {
 198                         $hours -= 12.0;
 199                 }
 200         }
 201         $str = sprintf("%d:%02d", $hours, $minutes);
 202         $str .= $suffix;
 203         return $str;
 204 }
 205
 206
 207
 208 # These are depricated! All but PULLDOWN_HASH still work, but you should update your code.
 209 define('PULLDOWN_AUTO', 0); define('PULLDOWN_ARRAY', 1); define('PULLDOWN_HASH', 2); define('PULLDOWN_2D', 3);
 210
 211
 212 # call this function before you run() the template so enc_options() knows what
 213 # to do
 214 #
 215 # Parameters:
 216 #
 217 #   name: the name of the html control
 218 #
 219 #   options: an array of options to display in the pulldown/selectbox. Each
 220 #   element can be either a string, or an array with two elements (first the
 221 #   value to post, and second the value to display in the pulldown)
 222 #
 223 #   multiple: UNTESTED set to true for multiple-select boxes.
 224
 225 function pulldown($name, $in_options, $multiple = false) {
 226         if($multiple === PULLDOWN_HASH) {
 227                 die('Webmaster error: PULLDOWN_HASH is depricated. Pass array(a,b) not a=>b');
 228         }
 229         if($multiple !== true) {
 230                 # Probably due to API change (removing 3rd argument) but don't bother
 231                 # emitting a warning, because the above warning handles the only
 232                 # important case.
 233                 $multiple = false;
 234         }
 235         $options = array();
 236         foreach($in_options as $option) {
 237                 if(is_array($option)) {
 238                         $options[] = $option;
 239                 } else {
 240                         $options[] = array($option, $option);
 241                 }
 242         }
 243         $GLOBALS[$name . '_options'] = array(
 244                 'options' => $options,
 245                 'multiple' => $multiple);
 246 }
 247
 248 # output a bunch of <option> tags
 249 function enc_options($values, $name) {
 250         if(!isset($GLOBALS[$name . '_options'])) {
 251                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 252         }
 253         if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
 254                 $values = explode(', ', $values);
 255         }
 256         return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_2D);
 257 }
 258
 259 # for radios and pulldowns:
 260 # pass posted value
 261 # returns what the user sees in the pulldown or on the radio button caption
 262 function enc_pulled($str, $name) {
 263         if(!isset($GLOBALS[$name . '_options'])) {
 264                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 265         }
 266         foreach($GLOBALS[$name . '_options']['options'] as &$kv) {
 267                 if($kv[0] == $str) {
 268                         return $kv[1];
 269                 }
 270         }
 271         return $str;
 272 }
 273
 274 function enc_radio_n($str, $name, $n) {
 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
 279         if(!isset($GLOBALS[$name . '_options']['options'][$n])) {
 280                 die("Template error: pulldown('$name') does not have element # $n");
 281         }
 282
 283         $value = enc_attr($GLOBALS[$name . '_options']['options'][$n][0]);
 284
 285         if($str === $value) {
 286                 $value .= '" checked="checked';
 287         }
 288
 289         return $value;
 290 }
 291 function enc_radio_0($str, $name) { return enc_radio_n($str, $name, 0); }
 292 function enc_radio_1($str, $name) { return enc_radio_n($str, $name, 1); }
 293 function enc_radio_2($str, $name) { return enc_radio_n($str, $name, 2); }
 294 function enc_radio_3($str, $name) { return enc_radio_n($str, $name, 3); }
 295 function enc_radio_4($str, $name) { return enc_radio_n($str, $name, 4); }
 296 function enc_radio_5($str, $name) { return enc_radio_n($str, $name, 5); }
 297 function enc_radio_6($str, $name) { return enc_radio_n($str, $name, 6); }
 298 function enc_radio_7($str, $name) { return enc_radio_n($str, $name, 7); }
 299
 300
 301 function enc_radio_caption_n($str, $name, $n) {
 302         if(!isset($GLOBALS[$name . '_options'])) {
 303                 die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
 304         }
 305
 306         if(!isset($GLOBALS[$name . '_options']['options'][$n])) {
 307                 die("Template error: pulldown('$name') does not have element #$n");
 308         }
 309
 310         return $GLOBALS[$name . '_options']['options'][$n][1];
 311 }
 312 function enc_radio_caption_0($str, $name) { return enc_radio_caption_n($str, $name, 0); }
 313 function enc_radio_caption_1($str, $name) { return enc_radio_caption_n($str, $name, 1); }
 314 function enc_radio_caption_2($str, $name) { return enc_radio_caption_n($str, $name, 2); }
 315 function enc_radio_caption_3($str, $name) { return enc_radio_caption_n($str, $name, 3); }
 316 function enc_radio_caption_4($str, $name) { return enc_radio_caption_n($str, $name, 4); }
 317 function enc_radio_caption_5($str, $name) { return enc_radio_caption_n($str, $name, 5); }
 318 function enc_radio_caption_6($str, $name) { return enc_radio_caption_n($str, $name, 6); }
 319 function enc_radio_caption_7($str, $name) { return enc_radio_caption_n($str, $name, 7); }
 320
 321
 322 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
 323 #
 324 # Parameters:
 325 #
 326 #    selected: can be a string or (for multiple-selects) an array
 327 #
 328 #    options, keys_from: see documentation for pulldown() above
 329 function encode_options($selected, $options, $keys_from) {
 330         if(!is_array($selected)) {
 331                 $selected = array($selected);
 332         }
 333
 334         if($keys_from != PULLDOWN_2D) {
 335                 $options = pulldown_options_to_2d($options, $keys_from);
 336         }
 337
 338         $out = '';
 339         foreach($options as $option) {
 340                 list($value, $display, $arg3) = $option;
 341                 $out .= '<option';
 342
 343                 if($arg3 == 'disabled') {
 344                         $out .= ' disabled';
 345                 } elseif(in_array($value, $selected)) {
 346                         $out .= ' selected';
 347                 }
 348
 349                 if($value !== $display || strpos($value, ' ') !== false) {
 350                         $out .= ' value="';
 351                         $out .= enc_attr($value);
 352                         $out .= '"';
 353                 }
 354
 355                 $out .= '>';
 356
 357                 $out .= enc_htmlnbsp($display);
 358
 359                 $out .= "</option>\n";
 360         }
 361
 362         return $out;
 363 }
 364
 365 $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");
 366
 367 # display <option>s
 368 function enc_states($str) {
 369         $ret = '';
 370
 371         return encode_options($str, $GLOBALS['wfpl_states_assoc'], PULLDOWN_HASH);
 372 }
 373
 374 $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");
 375
 376 # display <option>s
 377 function enc_provinces($str) {
 378         $ret = '';
 379
 380         return encode_options($str, $GLOBALS['wfpl_provinces_assoc'], PULLDOWN_HASH);
 381 }
 382
 383 # returns "odd", then "even", then "odd" etc.
 384 function enc_evenodd($values, $name) {
 385         if(!isset($GLOBALS['wfpl_even_odds'])) {
 386                 $GLOBALS['wfpl_even_odds'] = array();
 387         }
 388
 389         if($GLOBALS['wfpl_even_odds'][$name]) {
 390                 $GLOBALS['wfpl_even_odds'][$name] = false;
 391                 return 'even';
 392         } else {
 393                 $GLOBALS['wfpl_even_odds'][$name] = true;
 394                 return 'odd';
 395         }
 396 }
 397
 398 function enc_image_src($str) {
 399         list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
 400         return $src;
 401 }
 402
 403 function enc_image_width($str) {
 404         list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
 405         return $width;
 406 }
 407
 408 function enc_image_height($str) {
 409         list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
 410         return $height;
 411 }
 412
 413 function enc_thumb_src($str) {
 414         list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
 415         return $src;
 416 }
 417
 418 function enc_thumb_width($str) {
 419         list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
 420         return $width;
 421 }
 422 function enc_thumb_height($str) {
 423         list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
 424         return $height;
 425 }
 426
 427 # example template: Length: ~length html~ day~length s~
 428 function enc_s($str) {
 429         if($str == '1') {
 430                 return '';
 431         }
 432
 433         return 's';
 434 }
 435
 436 # turn http/ftp (s) urls into html links (and encode everything for html)
 437 # does not encode without protocol (eg "www.foo.com")
 438 # does not linkify email addresses
 439 function enc_linkify($str) {
 440         $ret = '';
 441         $even = true;
 442         $pieces = preg_split("/((?:ht|f)tps?:\/\/[^ \,\"\n\r\t<]+)/is", $str, null, PREG_SPLIT_DELIM_CAPTURE);
 443         foreach($pieces as $piece) {
 444                 if($even) {
 445                         $ret .= enc_html($piece);
 446                 } else {
 447                         $ret .= '<a href="' . enc_attr($piece) . '">' . enc_html($piece) . '</a>';
 448                 }
 449                 $even = !$even;
 450         }
 451         return $ret;
 452 }