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
  54 # Encode for output in html. Converts newlines to <br />
  55 #
  56 # Example: <p>~foo.html~</p>
  57 function enc_htmlbr($str) {
  58         $str = str_replace('&', '&amp;', $str);
  59         $str = str_replace('<', '&lt;', $str);
  60         $str = str_replace('>', '&gt;', $str);
  61         $str = str_replace("\n", "<br />\n", $str);
  62         return $str;
  63 }
  64
  65
  66 # HTML attribute.
  67 #
  68 # Example: <input name="foo" value="~foo.attr~">
  69 function enc_attr($str) {
  70         $str = str_replace('&', '&amp;', $str);
  71         $str = str_replace('"', '&quot;', $str);
  72         return $str;
  73 }
  74
  75 # URI agument value.
  76 #
  77 # Example:  <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
  78 function enc_url_val($str) {
  79         return rawurlencode($str);
  80 }
  81
  82 # This is a hack to work around html's stupid syntax for checkboxes.
  83 #
  84 # Place the template marker just before a " somewhere.
  85 #
  86 # Example: <input type="checkbox" name="foo~foo.checked~">
  87 function enc_checked($str) {
  88         if($str == 'Yes') {
  89                 return '" checked="checked';
  90         } else {
  91                 return '';
  92         }
  93 }
  94
  95 # add a tab at the begining of each non-empty line
  96 function enc_tab($str) {
  97         $lines = explode("\n", $str);
  98         $out = '';
  99         foreach($lines as $line) {
 100                 if($line) {
 101                         $out .= "\t$line";
 102                 }
 103                 $out .= "\n";
 104         }
 105
 106         # remove the extra newline added above
 107         return substr($out, 0, -1);
 108 }
 109
 110 function enc_upper($str) {
 111         return strtoupper($str);
 112 }
 113
 114
 115 # display <option>s
 116 function enc_states($str) {
 117         $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");
 118         $ret = '';
 119
 120         return encode_options($str, $states_assoc, $use_keys = true);
 121 }
 122
 123 # display <option>s
 124 function enc_provinces($str) {
 125         $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");
 126         $ret = '';
 127
 128         return encode_options($str, $provinces_assoc, $use_keys = true);
 129 }
 130
 131
 132
 133
 134
 135 define('PULLDOWN_ARRAY', 0); define('PULLDOWN_HASH', 1); define('PULLDOWN_2D', 2);
 136
 137 function pulldown_options_to_hash($options, $keys_from) {
 138         # convert other types of input to value=>display hash
 139         switch($keys_from) {
 140                 case PULLDOWN_HASH:
 141                         return $options;
 142                 case PULLDOWN_ARRAY:
 143                         $new_options = array();
 144                         foreach($options as $opt) {
 145                                 $new_options[$opt] = $opt;
 146                         }
 147                         return $new_options;
 148                 break;
 149                 case PULLDOWN_2D:
 150                         $new_options = array();
 151                         foreach($options as $opt) {
 152                                 $new_options[$opt[0]] = $opt[1];
 153                         }
 154                         return $new_options;
 155                 break;
 156                 default:
 157                         die('unknown value: "' . print_r($keys_from) . '" passed in $keys_from parameter');
 158         }
 159 }
 160
 161
 162 # call this function before you run() the template so enc_options() knows what
 163 # to do
 164 #
 165 # Parameters:
 166 #
 167 #   name: the name of the html control
 168 #
 169 #   options: an array of options to display in the pulldown/selectbox
 170 #
 171 #   keys_from: Set to one of:
 172 #        PULLDOWN_ARRAY: (default) values of $options are displayd and posted
 173 #        PULLDOWN_HASH: values of $options are display, keys are posted
 174 #        PULLDOWN_2D: $options is a 2 dimensional array.
 175 #                     $options[0][1] is displayed, $options[0][0] is posted.
 176 #                     $options[1][1] is displayed, $options[1][0] is posted.
 177 #
 178 #   multiple: UNTESTED set to true for multiple-select boxes.
 179
 180 function pulldown($name, $options, $keys_from = PULLDOWN_ARRAY, $multiple = false) {
 181         $options = pulldown_options_to_hash($options, $keys_from);
 182         $GLOBALS[$name . '_options'] = array();
 183         $GLOBALS[$name . '_options']['options'] = $options;
 184         $GLOBALS[$name . '_options']['multiple'] = $multiple;
 185 }
 186
 187 # output a bunch of <option> tags
 188 function enc_options($values, $name) {
 189         if(!isset($GLOBALS[$name . '_options'])) {
 190                 die('pulldown() must be called before this template can be run. See code/wfpl/encode.php');
 191         }
 192         if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
 193                 $values = explode(', ', $values);
 194         }
 195         return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_HASH);
 196 }
 197
 198 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
 199 #
 200 # Parameters:
 201 #
 202 #    selected: can be a string or (for multiple-selects) an array
 203 #
 204 #    options, keys_from: see documentation for pulldown() above
 205 function encode_options($selected, $options, $keys_from) {
 206         if(!is_array($selected)) {
 207                 $selected = array($selected);
 208         }
 209
 210         $options = pulldown_options_to_hash($options, $keys_from);
 211
 212         $out = '';
 213         foreach($options as $value => $display) {
 214                 $out .= '<option';
 215
 216                 if(in_array($value, $selected)) {
 217                         $out .= ' selected="selected"';
 218                 }
 219
 220                 if($value !== $display) {
 221                         $out .= ' value="';
 222                         $out .= enc_attr($value);
 223                         $out .= '"';
 224                 }
 225
 226                 $out .= '>';
 227
 228                 $out .= enc_html($display);
 229
 230                 $out .= "</option>\n";
 231         }
 232
 233         return $out;
 234 }
 235
 236 ?>