encode.php

   1 <?php
   2
   3 #  Copyright (C) 2005 Jason Woofenden
   4 #
   5 #  This file is part of wfpl.
   6 #
   7 #  wfpl is free software; you can redistribute it and/or modify it under the
   8 #  terms of the GNU Lesser General Public License as published by the Free
   9 #  Software Foundation; either version 2.1 of the License, or (at your option)
  10 #  any later version.
  11 #
  12 #  wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
  13 #  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14 #  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
  15 #  more details.
  16 #
  17 #  You should have received a copy of the GNU Lesser General Public License
  18 #  along with wfpl; if not, write to the Free Software Foundation, Inc., 51
  19 #  Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21
  22 # This file contains basic encodings. These are used by the encoder. You can
  23 # specify any template tag to be encoded with this syntax: ~variable.encoding~
  24 #
  25 # this example: <p>~foo.html~</p>
  26 # will encode foo (using enc_html()) before displaying it, so that characters
  27 # such as < will display properly.
  28
  29
  30 function enc_jsdq($str) {
  31         $str = enc_sql($str);
  32         $str = str_replace("\n", "\\n", $str);
  33         return str_replace("\r", "\\r", $str);
  34 }
  35
  36 # encode for putting within double-quotes in SQL
  37 function enc_sql($str) {
  38         $str = str_replace("\\", "\\\\", $str);
  39         $str = str_replace('"', "\\\"", $str);
  40         return $str;
  41 }
  42
  43 # Encode for output in html. does nothing with whitespace
  44 #
  45 # Example: <p>~foo.html~</p>
  46 function enc_html($str) {
  47         $str = str_replace('&', '&amp;', $str);
  48         $str = str_replace('<', '&lt;', $str);
  49         $str = str_replace('>', '&gt;', $str);
  50         return $str;
  51 }
  52
  53 # Encode for output in html. Convert newlines to <br />
  54 #
  55 # Example: <p>~foo.html~</p>
  56 function enc_htmlbr($str) {
  57         $str = enc_html($str);
  58         $str = str_replace("\n", "<br />\n", $str);
  59         return $str;
  60 }
  61
  62 # Encode for output in html. Spaces converted to &nbsp;
  63 #
  64 # Example: <option value="12">~foo.htmlnbsp~</option>
  65 function enc_htmlnbsp($str) {
  66         $str = enc_html($str);
  67         $str = str_replace(' ', '&nbsp;', $str);
  68         return $str;
  69 }
  70
  71
  72 # HTML attribute.
  73 #
  74 # Example: <input name="foo" value="~foo.attr~">
  75 function enc_attr($str) {
  76         $str = str_replace('&', '&amp;', $str);
  77         $str = str_replace('"', '&quot;', $str);
  78         return $str;
  79 }
  80
  81 # URI agument value.
  82 #
  83 # Example:  <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
  84 function enc_url_val($str) {
  85         return rawurlencode($str);
  86 }
  87
  88 # FIXME
  89 function enc_url_path($str) {
  90         $str = rawurlencode($str);
  91         $str = str_replace('%2F', '/', $str);
  92         return $str;
  93 }
  94
  95
  96 # This is a hack to work around html's stupid syntax for checkboxes.
  97 #
  98 # Place the template marker just before a " somewhere.
  99 #
 100 # Example: <input type="checkbox" name="foo~foo.checked~">
 101 function enc_checked($str) {
 102         if($str == 'Yes') {
 103                 return '" checked="checked';
 104         } else {
 105                 return '';
 106         }
 107 }
 108
 109 # add a tab at the begining of each non-empty line
 110 function enc_tab($str) {
 111         $lines = explode("\n", $str);
 112         $out = '';
 113         foreach($lines as $line) {
 114                 if($line) {
 115                         $out .= "\t$line";
 116                 }
 117                 $out .= "\n";
 118         }
 119
 120         # remove the extra newline added above
 121         return substr($out, 0, -1);
 122 }
 123
 124 function enc_upper($str) {
 125         return strtoupper($str);
 126 }
 127
 128 function enc_ddmmyyyyhhmm($seconds) {
 129         return date('m/d/Y g:ia', (int)$seconds);
 130 }
 131
 132
 133 # display <option>s
 134 function enc_states($str) {
 135         $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");
 136         $ret = '';
 137
 138         return encode_options($str, $states_assoc, $use_keys = true);
 139 }
 140
 141 # display <option>s
 142 function enc_provinces($str) {
 143         $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");
 144         $ret = '';
 145
 146         return encode_options($str, $provinces_assoc, $use_keys = true);
 147 }
 148
 149
 150
 151
 152
 153 define('PULLDOWN_ARRAY', 0); define('PULLDOWN_HASH', 1); define('PULLDOWN_2D', 2);
 154
 155 function pulldown_options_to_hash($options, $keys_from) {
 156         # convert other types of input to value=>display hash
 157         switch($keys_from) {
 158                 case PULLDOWN_HASH:
 159                         return $options;
 160                 case PULLDOWN_ARRAY:
 161                         $new_options = array();
 162                         foreach($options as $opt) {
 163                                 $new_options[$opt] = $opt;
 164                         }
 165                         return $new_options;
 166                 break;
 167                 case PULLDOWN_2D:
 168                         $new_options = array();
 169                         foreach($options as $opt) {
 170                                 $new_options[$opt[0]] = $opt[1];
 171                         }
 172                         return $new_options;
 173                 break;
 174                 default:
 175                         die('unknown value: "' . print_r($keys_from) . '" passed in $keys_from parameter');
 176         }
 177 }
 178
 179
 180 # call this function before you run() the template so enc_options() knows what
 181 # to do
 182 #
 183 # Parameters:
 184 #
 185 #   name: the name of the html control
 186 #
 187 #   options: an array of options to display in the pulldown/selectbox
 188 #
 189 #   keys_from: Set to one of:
 190 #        PULLDOWN_ARRAY: (default) values of $options are displayd and posted
 191 #        PULLDOWN_HASH: values of $options are display, keys are posted
 192 #        PULLDOWN_2D: $options is a 2 dimensional array.
 193 #                     $options[0][1] is displayed, $options[0][0] is posted.
 194 #                     $options[1][1] is displayed, $options[1][0] is posted.
 195 #
 196 #   multiple: UNTESTED set to true for multiple-select boxes.
 197
 198 function pulldown($name, $options, $keys_from = PULLDOWN_ARRAY, $multiple = false) {
 199         $options = pulldown_options_to_hash($options, $keys_from);
 200         $GLOBALS[$name . '_options'] = array();
 201         $GLOBALS[$name . '_options']['options'] = $options;
 202         $GLOBALS[$name . '_options']['multiple'] = $multiple;
 203 }
 204
 205 # output a bunch of <option> tags
 206 function enc_options($values, $name) {
 207         if(!isset($GLOBALS[$name . '_options'])) {
 208                 die('pulldown() must be called before this template can be run. See code/wfpl/encode.php');
 209         }
 210         if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
 211                 $values = explode(', ', $values);
 212         }
 213         return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_HASH);
 214 }
 215
 216 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
 217 #
 218 # Parameters:
 219 #
 220 #    selected: can be a string or (for multiple-selects) an array
 221 #
 222 #    options, keys_from: see documentation for pulldown() above
 223 function encode_options($selected, $options, $keys_from) {
 224         if(!is_array($selected)) {
 225                 $selected = array($selected);
 226         }
 227
 228         $options = pulldown_options_to_hash($options, $keys_from);
 229
 230         $out = '';
 231         foreach($options as $value => $display) {
 232                 $out .= '<option';
 233
 234                 if(in_array($value, $selected)) {
 235                         $out .= ' selected="selected"';
 236                 }
 237
 238                 if($value !== $display) {
 239                         $out .= ' value="';
 240                         $out .= enc_attr($value);
 241                         $out .= '"';
 242                 }
 243
 244                 $out .= '>';
 245
 246                 $out .= enc_htmlnbsp($display);
 247
 248                 $out .= "</option>\n";
 249         }
 250
 251         return $out;
 252 }
 253
 254 ?>