JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Fix db_get_value after mysql->mysqli upgrade
[wfpl.git] / format.php
index 055e66d..6b14ad7 100644 (file)
 <?php
 
-#  Copyright (C) 2005 Jason Woofenden
-#
-#  This file is part of wfpl.
-#
-#  wfpl is free software; you can redistribute it and/or modify it under the
-#  terms of the GNU Lesser General Public License as published by the Free
-#  Software Foundation; either version 2.1 of the License, or (at your option)
-#  any later version.
-#
-#  wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
-#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-#  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
-#  more details.
-#
-#  You should have received a copy of the GNU Lesser General Public License
-#  along with wfpl; if not, write to the Free Software Foundation, Inc., 51
-#  Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+# This program is in the public domain within the United States. Additionally,
+# we waive copyright and related rights in the work worldwide through the CC0
+# 1.0 Universal public domain dedication, which can be found at
+# http://creativecommons.org/publicdomain/zero/1.0/
 
 
 # This file contains basic encodings
 
+function format_caption($str) {
+       $str = preg_replace("/([a-z])([A-Z])/", "\\1 \\2", $str); # split words on camelCase
+       $str = str_replace('_', ' ', $str);
+       $str = ucwords($str);
+       return $str;
+}
+
+# This function makes sure that $str is in the list of options, and returns "" otherwise
+function format_options($str, $name) {
+       if(!isset($GLOBALS[$name . '_options'])) {
+               die("Couldn't find options for \"$name\". Be sure to call pulldown().");
+       }
+
+       foreach($GLOBALS[$name . '_options']['options'] as $keyval) {
+               list($key, $value) = $keyval;
+               if($str == $key) {
+                       return $str;
+               }
+       }
+
+       return '';
+}
+
 function format_int($str) {
-       $str = ereg_replace('[^0-9]', '', $str);
-       return ereg_replace('^0*([1-9])', '\1', $str);
+       $str = preg_replace('|[^0-9]|', '', $str);
+       return preg_replace('|^0*([0-9])|', '\1', $str);
+}
+
+# format the digits after the decimal point
+function format_decimals($str) {
+       $str = preg_replace('|[^0-9]|', '', $str);
+       if(strlen($str)) {
+               $str = substr($str, 0, 1) . preg_replace('|0*$|', '', substr($str, 1));
+       }
+       return $str;
+}
+
+function _format_positive_decimal($str) {
+       $str = preg_replace('|[^0-9.]|', '', $str);
+       $pos = strpos($str, '.');
+       if($pos !== false) {
+               $str = str_replace('.', '', $str);
+               if($pos == 0) {
+                       return '0.' . format_decimals($str);
+               } elseif($pos == strlen($str)) {
+                       return format_int($str);
+               } else {
+                       return format_int(substr($str, 0, $pos)) . '.' . format_decimals(substr($str, $pos));
+               }
+       }
+       return format_int($str);
+}
+
+function format_positive_decimal($str) {
+       $str = _format_positive_decimal($str);
+       if(substr($str, -2) === '.0') {
+               $str = substr($str, 0, -2);
+       }
+       return $str;
 }
 
+function format_decimal($str) {
+       $str = preg_replace('|[^0-9.-]|', '', $str);
+       if(substr($str, 0, 1) == '-') {
+               $str = format_positive_decimal(substr($str, 1));
+               if($str !== '' && $str !== '0') {
+                       $str = '-' . $str;
+               }
+               return $str;
+       } else {
+               return format_positive_decimal($str);
+       }
+}
+
+# return 0 of there's no digits
+function format_int_0($str) {
+       $str = format_int($str);
+       if($str == '') {
+               return '0';
+       }
+       return $str;
+}
+
+# USA zip codes
 function format_zip($str) {
-       return ereg_replace('[^0-9]', '', $str);
+       $str = preg_replace('|[^0-9]|', '', $str);
+       if(strlen($str) > 5) {
+               return substr($str, 0, 5) . '-' . substr($str, 5);
+       }
+       return $str;
+}
+
+function format_filename($str, $allow_uppercase = false) {
+       if(!$allow_uppercase) {
+               $str = strtolower($str);
+       }
+       $str = preg_replace('|[^a-z0-9_.-]|i', '_', $str);
+       return preg_replace('|^[.-]|', '_', $str);
+}
+
+function format_path($str, $allow_uppercase = false) {
+       if(!$allow_uppercase) {
+               $str = strtolower($str);
+       }
+       $str = preg_replace('|[^a-z0-9_./-]|i', '_', $str);
+       return preg_replace('|^[.-]|', '_', $str);
+}
+
+function client_path_to_filename($path) {
+       $filename = preg_replace("|.*[:/\\\\]|", '', $path);
+       return format_filename($filename, true);
+}
+
+
+function format_image_w_h($str) {
+       $fields = explode(' ', $str);
+       if(count($fields) != 3) {
+               return '';
+       }
+
+       list($filename, $width, $height) = $fields;
+       $filename = format_path($filename);
+       $width = format_int_0($width);
+       $height = format_int_0($height);
+
+       return "$filename $width $height";
 }
 
-function format_filename($str) {
+function format_image_w_h_thumb_w_h($str) {
+       $fields = explode(' ', $str);
+       if(count($fields) != 6) {
+               return '';
+       }
+
+       list($filename, $width, $height, $thumb_filename, $thumb_width, $thumb_height) = $fields;
+       $filename = format_path($filename);
+       $width = format_int_0($width);
+       $height = format_int_0($height);
+       $thumb_filename = format_path($thumb_filename);
+       $thumb_width = format_int_0($thumb_width);
+       $thumb_height = format_int_0($thumb_height);
+
+       return "$filename $width $height $thumb_filename $thumb_width $thumb_height";
+}
+
+function format_slug($str) {
        $str = strtolower($str);
-       $str = ereg_replace('[^a-z0-9_.-]', '_', $str);
-       return ereg_replace('^[.-]', '_', $str);
+       $str = str_replace("'", '', $str);
+       $str = preg_replace('/[^a-z0-9-]+/', '-', $str);
+       return trim($str, '-');
 }
 
 function format_varname($str) {
+       $str = preg_replace("/([a-z])([A-Z])/", "\\1_\\2", $str); # split words on camelCase
        $str = strtolower($str);
-       $str = ereg_replace('[^a-z0-9_]', '_', $str);
-       return ereg_replace('^[0-9]*', '', $str);
+       $str = preg_replace("/['‘’]/", '', $str);
+       $str = preg_replace('/[^a-z0-9_]+/', '_', $str);
+       return preg_replace('/^([^a-z_])/', "_\\1", $str);
 }
 
 function format_oneline($str) {
@@ -51,8 +177,16 @@ function format_unix($str) {
        return unix_newlines($str);
 }
 
+function format_bool($str) {
+       if($str && $str !== 'No' && $str !== 'False' && $str !== 'false' && $str !== 'no' && $str !== 'N' &&  $str !== 'n') {
+               return 1;
+       } else {
+               return 0;
+       }
+}
+
 function format_yesno($str) {
-       if($str && $str != 'No') {
+       if($str && $str !== 'No' && $str !== 'False' && $str !== 'false' && $str !== 'no' && $str !== 'N' &&  $str !== 'n') {
                return 'Yes';
        } else {
                return 'No';
@@ -61,50 +195,167 @@ function format_yesno($str) {
 
 function format_email($str) {
        # FIXME
-       return format_oneline($str);
+       return trim(format_oneline($str));
 }
 
 function format_url($str) {
-       # FIXME
-       return format_oneline($str);
+       # FIXME check for TLD? encode special chars?
+       $str = trim(format_oneline($str));
+       if($str !== '') {
+               if(strpos($str, ':') === false) {
+                       $str = 'http://' . $str;
+               }
+       }
+       return $str;
 }
 
+# pass a string containing only numeric digits.
+# returns a string containing only numeric digits which is 1 greater.
+function strplusone($str) {
+       $ret = '';
+       $a = str_split($str);
+       $carry = 1;
+       while($a) {
+               $digit = array_pop($a);
+               $digit += $carry;
+               $carry = 0;
+               if($digit == 10) {
+                       $carry = 1;
+                       $digit = 0;
+               }
+               $ret = "$digit$ret";
+       }
+       if($carry) {
+               $ret = "$carry$ret";
+       }
+
+       return $ret;
+}
+
+# rounds properly to the nearest penny (or dollar if you pass false for the 2nd
+# parameter) and prints like so: $12,456.79 or $12,457
 function format_money($str, $display_cents = true) {
-       $str = ereg_replace('[^0-9.]', '', $str);
-       if($display_cents) {
-               $int = (int)($str * 100);
-               $cents = $int % 100;
-               $cents = sprintf('.%02d', $cents);
-               $int = (int)($str); # go from the source again, so we can print numbers above 2M without cents.
+       $str = format_decimal($str);
+       if($str == '') {
+               $str = '0';
+       }
+       if(strpos($str, '.')) {
+               list($int, $decimals) = explode('.', $str);
+               if(strlen($decimals) == 1) {
+                       $decimals .= '0';
+               }
+               if($display_cents) {
+                       if(strlen($decimals) > 2) {
+                               # round up to the nearest penny
+                               if(substr($decimals, 2, 1) >= 5) {
+                                       $decimals = strplusone(substr($decimals, 0, 2));
+                                       if($decimals == '100') {
+                                               $decimals = '00';
+                                               $int = strplusone($int);
+                                       }
+                               } else {
+                                       $decimals = substr($decimals, 0, 2);
+                               }
+                       }
+                       $cents = ".$decimals";
+               } else {
+                       if(substr($decimals, 0, 1) >= 5) {
+                               $int = strplusone($int);
+                       }
+               }
        } else {
-               $cents = '';
-               $int = round($str);
+               $int = $str;
+               if($display_cents) {
+                       $cents = '.00';
+               }
        }
-       $chars = (string)$int;
+       $chars = str_split($int);
        $output = '';
        $comma = 4;
-       $index = strlen($chars);
-       while($index) {
-               --$index;
+       while($chars) {
                --$comma;
                if($comma == 0) {
                        $comma = 3;
                        $output = ',' . $output;
                }
-               $char = substr($chars, $index, 1);
+               $char = array_pop($chars);
                $output = $char . $output;
        }
        $output = '$' . $output . $cents;
        return $output;
 }
 
+
 function format_dollars($str) {
        return format_money($str, false);
 }
 
+# date is edited as mm/dd/yyyy but stored as yyyy-mm-dd
+function format_mdy_to_ymd($str) {
+       if($str == '') return '';
+       require_once(__DIR__.'/'.'time.php');
+       return mdy_to_ymd(format_oneline($str));
+}
+
+# date is yyyy-mm-dd
+function format_ymd($str) {
+       require_once(__DIR__.'/'.'time.php');
+       list($year, $month, $day) = ymd_clean($str);
+       return sprintf('%04u-%02u-%02u', $year, $month, $day);
+}
+
+# takes any of: HH  :MM  HH:MM
+# returns decimal number of hours
+#
+# You probably want to use format_hours() instead because it handles hours with a decimal point.
+function format_hours_minutes($str) {
+       if(strlen($str) == 0) {
+               return $str;
+       }
+       $pos = strpos($str, ':');
+       if($pos === false) {
+               $hours = format_int_0($str);
+               $minutes = 0;
+       } elseif($pos == 0) {
+               $hours = 0;
+               $minutes = format_int_0($str);
+       } else {
+               $hours = format_int_0(substr($str, 0, $pos));
+               $minutes = format_int_0(substr($str, $pos + 1));
+       }
+       return $hours + ($minutes / 60.0);
+}
+
+# takes any of: HH  :MM  HH:MM  HH.hh(decimal hours)
+# returns decimal number of hours
+function format_hours($str) {
+       if(strlen($str) == 0) {
+               return $str;
+       }
+       if(strpos($str, ':') !== false) {
+               return format_hours_minutes($str);
+       } else {
+               return format_decimal($str);
+       }
+}
+
+# takes eg 12:23am
+# returns decimal number of hours since midnight
+function format_12hr_to_hours($str) {
+       if(preg_match('|noon|i', $str) === 1) {
+               return 12;
+       }
+       $hours = format_hours($str);
+       if($hours < 12 && preg_match('|p|i', $str) === 1) {
+               $hours += 12;
+       }
+       return $hours;
+}
+
+
 function format_phone($str) {
-       $str = ereg_replace('[^0-9]', '', $str);
-       $str = ereg_replace('^1*', '', $str);
+       $str = preg_replace('|[^0-9]|', '', $str);
+       $str = preg_replace('|^1*|', '', $str);
        $len = strlen($str);
        $output = '';
 
@@ -132,5 +383,3 @@ function format_phone($str) {
 
        return $output;
 }
-
-?>