JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
initial import (from revision 1199 + email.php)
authorJason Woofenden <jason@vorticies.(none)>
Sun, 10 Dec 2006 09:16:40 +0000 (04:16 -0500)
committerJason Woofenden <jason@vorticies.(none)>
Sun, 10 Dec 2006 09:16:40 +0000 (04:16 -0500)
COPYING [new file with mode: 0644]
doc/template.php.txt [new file with mode: 0644]
email.php [new file with mode: 0644]
encode.php [new file with mode: 0644]
format.php [new file with mode: 0644]
http.php [new file with mode: 0644]
run_file.php [new file with mode: 0644]
template.php [new file with mode: 0644]
test/tem_test.php [new file with mode: 0644]
test/tem_test.php.html [new file with mode: 0644]

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..f90922e
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,340 @@
+                   GNU GENERAL PUBLIC LICENSE
+                      Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                           Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                   GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                           NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                    END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/doc/template.php.txt b/doc/template.php.txt
new file mode 100644 (file)
index 0000000..0abfb73
--- /dev/null
@@ -0,0 +1,42 @@
+       First you have some globally accessible array of key->value pairs which contain the data to be entered into templates
+
+       Then you have some template files
+
+tem_set($key, $value)
+tem_get($key)
+tem_run($file/template)
+tem_echo($file/template) { echo tem_run($file); }
+
+This should work for simple templates such as:  foo: '~foo~'
+
+
+       It gets trickier when you have bits in your template that need to be repeated
+       (with different tags each time) and others perhaps not displayed at all.
+
+       foobar.html:
+
+<table>
+<tr><th>foo</th><th>bar</th></tr>
+<!--~foobar_row start~--><tr><td>~foo~</td><td><input value="~bar~"></tr><!--~end~-->
+</table>
+
+tem_load('foobar.html');
+
+               
+               the main template (with the sub-templates like foobar_row replaced with a single tag ie:
+
+<table>
+<tr><th>foo</th><th>bar</th></tr>
+~foobar_row~
+</table>
+
+       Main data structure:
+               key/value pairs
+               template file (if template string is empty, it will be read from here)
+               template string
+               sub templates:
+                       key: foobar_row
+                       value: <tr><td>~foo.....html~</td><td><input value="~bar.attr~"></tr>
+
+
+tmpl_insert('foobar_row');
diff --git a/email.php b/email.php
new file mode 100644 (file)
index 0000000..5d119fc
--- /dev/null
+++ b/email.php
@@ -0,0 +1,96 @@
+<?php
+
+#  Copyright (C) 2006 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 General Public License as published by
+#  the Free Software Foundation; either version 2, 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
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with wfpl; see the file COPYING.  If not, write to the
+#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+#  MA 02111-1307, USA.
+
+
+
+# This function will SAFELY send e-mail (ie you can pass parameters to it
+# that you got from a form and not worry about header injection.) Weird
+# characters are stripped from the $subject and from the real names, but e-mail
+# addresses are not modified at all. If an e-mail address is invalid this
+# function will return non-zero.
+
+# You cannot pass more than one address to any parameter
+# address fields (from, to, cc, bcc) can be in either of these formats:
+# 1) me@foo.com  2) Me Who <me@foo.com>
+# returns 0 on success
+function email($from, $to, $subject, $message, $cc = '', $bcc = '') {
+       if(($from = email_header($from)) === false) { return 1; }
+       if(($to   = email_header($to))   === false) { return 2; }
+       if(($cc   = email_header($cc))   === false) { return 3; }
+       if(($bcc  = email_header($bcc))  === false) { return 4; }
+       if($from == '') { return 1; }
+       if($to   == '') { return 2; }
+
+       #FIXME should allow many more characters here
+       $subject = ereg_replace("[^a-zA-Z _'-]", '_', $subject);
+
+       $headers = "From: $from";
+       if($cc) {
+               $headers .= "\r\nCC: $cc";
+       }
+       if($bcc) {
+               $headers .= "\r\nBCC: $bcc";
+       }
+       if(mail($to, $subject, $message, $headers)) {
+               return 0;
+       } else {
+               return 5;
+       }
+}
+       
+
+
+# This function probably isn't useful appart from writing functions like email() above.
+
+# addr can be in these formats:
+# 1) me@foo.com  2) Me Who <me@foo.com>  3)
+# returns false, or a valid format 2 above, except if input is an empty string, it'll return an empty string
+function email_header($addr) {
+       if($addr == '') {
+               return '';
+       }
+
+       if(ereg('<.*>$', $addr) !== false) {
+               # format 2
+               list($name, $email) = split('<', $addr);
+               $name = rtrim($name);
+               $email = substr($email, 0, -1); # get rid of the '>' at the end
+       } else {
+               $email = $addr;
+               $name = ereg_replace('@.*', '', $addr);
+       }
+
+       if(!valid_email($email)) {
+               return false;
+       }
+
+       #FIXME should allow many more characters here
+       $name = ereg_replace("[^a-zA-Z _'-]", '_', $name);
+
+       return $name . ' <' . $email . '>';
+}
+       
+
+
+# return true if e-mail is formatted like a valid email address
+function valid_email($email) {
+       return ereg('^[0-9a-zA-Z_~.-]+@[0-9a-zA-Z.-]+\.[a-z]+$', $email) !== false;
+}
diff --git a/encode.php b/encode.php
new file mode 100644 (file)
index 0000000..90ec6c8
--- /dev/null
@@ -0,0 +1,40 @@
+<?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 General Public License as published by
+#  the Free Software Foundation; either version 2, 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
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with wfpl; see the file COPYING.  If not, write to the
+#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+#  MA 02111-1307, USA.
+
+
+# This file contains basic encodings
+
+function enc_html($str) {
+       $str = str_replace('&', '&amp;', $str);
+       $str = str_replace('<', '&lt;', $str);
+       $str = str_replace('>', '&gt;', $str);
+       return $str;
+}
+
+
+# html attributes (eg  <input value="...."
+function enc_attr($str) {
+       $str = str_replace('&', '&amp;', $str);
+       $str = str_replace('"', '&quot;', $str);
+       return $str;
+}
+
+
diff --git a/format.php b/format.php
new file mode 100644 (file)
index 0000000..411a09a
--- /dev/null
@@ -0,0 +1,109 @@
+<?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 General Public License as published by
+#  the Free Software Foundation; either version 2, 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
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with wfpl; see the file COPYING.  If not, write to the
+#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+#  MA 02111-1307, USA.
+
+
+# This file contains basic encodings
+
+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.
+       } else {
+               $cents = '';
+               $int = round($str);
+       }
+       $chars = (string)$int;
+       $output = '';
+       $comma = 4;
+       $index = strlen($chars);
+       while($index) {
+               --$index;
+               --$comma;
+               if($comma == 0) {
+                       $comma = 3;
+                       $output = ',' . $output;
+               }
+               $char = substr($chars, $index, 1);
+               $output = $char . $output;
+       }
+       $output = '$' . $output . $cents;
+       return $output;
+}
+
+function format_dollars($str) {
+       return format_money($str, false);
+}
+
+function format_phone($str) {
+       $str = ereg_replace('[^0-9]', '', $str);
+       $str = ereg_replace('^1*', '', $str);
+       $len = strlen($str);
+       $output = '';
+
+       if($len < 10 && $len != 7) {
+               #NOT A VALID PHONE NUMBER
+               return $str;
+       }
+
+       if($len > 10) {
+               $output = ' ext: ' . substr($str, 10);
+               $len = 10;
+       }
+
+       if($len == 10) {
+               $area = substr($str, 0, 3);
+               $str = substr($str, 3);
+       }
+
+       $output = substr($str, 3) . $output;
+       $output = substr($str, 0, 3) . '-' . $output;
+
+       if($area) {
+               $output = "($area) " . $output;
+       }
+
+       return $output;
+}
+
+
+#function ftest($val) {
+#      printf("$val: '%s'<br />\n", format_phone($val, true));
+#}
+#
+#echo "FORMAT TESTS<br><br>";
+#ftest("$3");
+#ftest("3.99");
+#ftest("3.5");
+#ftest("891234");
+#ftest("8221234");
+#ftest("82212334");
+#ftest("122313234");
+#ftest("1158221234");
+#ftest("1558221234");
+#ftest("12235513234");
+#ftest("122355123334");
+#ftest("1585552212334");
+#ftest("15855522123334");
+
+?>
diff --git a/http.php b/http.php
new file mode 100644 (file)
index 0000000..c38f97d
--- /dev/null
+++ b/http.php
@@ -0,0 +1,51 @@
+<?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 General Public License as published by
+#  the Free Software Foundation; either version 2, 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
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with wfpl; see the file COPYING.  If not, write to the
+#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+#  MA 02111-1307, USA.
+
+
+# return our best guess at the url used to access this page
+function this_url() {
+       list($protocol, $version) = explode('/', $_SERVER['SERVER_PROTOCOL']);
+       $url = strtolower($protocol);
+
+       if($url == 'http') {
+               $expected_port = 80;
+       } elseif ($url == 'https') {
+               $expected_port = 443;
+       } else {
+               $expected_port = -1;
+       }
+
+       $url .= '://';
+       if($_SERVER['HTTP_HOST']) {
+               $url .= $_SERVER['HTTP_HOST'];
+       } else {
+               $url .= $_SERVER['SERVER_NAME'];
+               if($_SERVER['SERVER_PORT'] != $expected_port) {
+                       $url .= ':' . $_SERVER['SERVER_PORT'];
+               }
+       }
+
+       $url .= $_SERVER['REQUEST_URI'];
+
+       return $url;
+}
+
+?>
diff --git a/run_file.php b/run_file.php
new file mode 100644 (file)
index 0000000..014cab5
--- /dev/null
@@ -0,0 +1,47 @@
+<?
+
+#  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 General Public License as published by
+#  the Free Software Foundation; either version 2, 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
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with wfpl; see the file COPYING.  If not, write to the
+#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+#  MA 02111-1307, USA.
+
+
+# This function makes it easier to put everything in functions like you should.
+#
+# Instead of putting everything in the global namespace and having it run when
+# you include the file, put everything in functions. This function makes it so
+# you can both include (require_once) the file, and call its main function in
+# one easy step.
+
+# EXAMPLE
+#
+# list($user, $pass) = file_run('db_password.php');
+#
+# the file db_password.php would be like so:
+#
+#     function db_password() {
+#           return array('me', 'secret');
+#     }
+
+function file_run($filename) {
+    require_once($filename);
+    ereg_replace('.*/', '', $filename);
+    $func = basename($filename, '.php');
+    return $func();
+}
+
+?>
diff --git a/template.php b/template.php
new file mode 100644 (file)
index 0000000..c56e743
--- /dev/null
@@ -0,0 +1,222 @@
+<?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 General Public License as published by
+#  the Free Software Foundation; either version 2, 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
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with wfpl; see the file COPYING.  If not, write to the
+#  Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+#  MA 02111-1307, USA.
+
+
+# This file contains generally useful template handling code. It is wrapped in
+# an object so that if you want/need to you can make more than one instance of
+# it and they won't step on each other's toes. Also there are a set of global
+# functions at the bottom so you don't have to mess around with objects if you
+# don't want to. The documentation will be on the object methods, but just know
+# that each has a straight function wrapper at the bottom with 'tem_' prepended
+# to the name.
+
+# This is designed to be as simple as it can be for your project. The simple
+# way to use it is to set some key/value pairs with tem_set() then call
+# tem_output('filename.html') to output the page. A more complex example
+# including the use of sub-templates can be found in tem_test.php
+
+require_once('code/wfpl/encode.php');
+
+class tem {
+       var $keyval;        # an array containing key/value pairs 
+       var $filename;      # template filename (sometimes unset)
+       var $template;      # contents of template
+       var $sub_templates; # tag-name/template-string pairs
+
+       # initialize variables
+       function tem() {
+               $this->keyval = array('' => '~');
+               $this->sub_templates = array();
+       }
+
+       # set a key/value pair. if a ~tag~ in the template matches key it will be replaced by value
+       function set($key, $value) {
+               $this->keyval[$key] = $value;
+       }
+
+       # grab a value you stuck in earlier with set()
+       function get($key) {
+               return $this->keyval[$key];
+       }
+
+       # run the template engine on one of the sub-templates and append the result
+       # to the keyval in the main array. See tem_test.php for an example of how
+       # this can be used.
+       function sub($sub_template_name) {
+               $this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
+       }
+
+       # this is used by tem::load() and should be otherwise useless
+       function _load(&$in, &$out) {
+               while($in) {
+                       # scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file
+                       $n = strpos($in, '<!--~');
+                       if($n === false) { # not found
+                               # we hit the end of the file
+                               $out .= $in;
+                               $in = '';
+                               return;
+                       }
+
+                       $out .= substr($in, 0, $n);
+                       $in = substr($in, $n);
+
+                       #we found something.
+                       #is it an end tag?
+                       if(strcmp('<!--~end~-->', substr($in, 0, 12)) == 0) {
+                               $in = substr($in, 12);
+                               return;
+                       }
+
+                       $matches = array();
+                       # this limits sub_template names to 50 chars
+                       if(ereg('<!--~([^~]*) start~-->', substr($in, 0, 65), $matches)) {
+                               list($start_tag, $tag_name) = $matches;
+                               $out .= '~' . $tag_name . '~';
+                               $in = substr($in, strlen($start_tag));
+                               $this->sub_templates[$tag_name] = '';
+                               $this->_load($in, $this->sub_templates[$tag_name]);
+                       } else {
+                               # it's not a start tag or end tag, so let's pass it through:
+                               $out .= substr($in, 0, 5);
+                               $in = substr($in, 5);
+                       }
+               } #repeat
+       }
+
+       # This is useful when you have sub-templates that you want to mess with
+       # before the main template is run. But can also be used to simply specify
+       # the filename ahead of time.
+       function load($filename) {
+               $this->filename = $filename;
+               $tmp = read_whole_file($filename);
+               $this->template = '';
+               $this->_load($tmp, $this->template);
+       }
+               
+       # Run the template. Pass a filename, or a string, unless you've already
+       # specified a template with load()
+       function run($templ = false) {
+               if($templ !== false) {
+                       if(strlen($templ) < 150 && file_exists($templ)) {
+                               $this->filename = $templ;
+                               unset($this->template);
+                       } else {
+                               $this->template = $templ;
+                       }
+               }
+
+               if(!$this->template) {
+                       if(!$this->filename) {
+                               print "sorry, no template to run\n";
+                               exit(1);
+                       }
+
+                       $this->template = read_whole_file($this->filename);
+               }
+               
+               return template_run($this->template, $this->keyval);
+       }       
+
+       # same as run() except the output is print()ed
+       function output($templ = false) {
+               print($this->run($templ));
+       }
+}
+
+# Below are functions so you can use the above class without allocating or
+# keeping track of it.
+
+# get a reference to the current template object
+function tem_init() { 
+       if(!$GLOBALS['wfpl_template']) {
+               $GLOBALS['wfpl_template'] = new tem();
+       }
+}
+               
+function tem_set($key, $value) {
+       tem_init();
+       $GLOBALS['wfpl_template']->set($key, $value);
+}
+       
+function tem_get($key) {
+       tem_init();
+       return $GLOBALS['wfpl_template']->get($key);
+}
+
+function tem_run($templ = false) {
+       tem_init();
+       return $GLOBALS['wfpl_template']->run($templ);
+}
+
+function tem_sub($sub_template_name) {
+       tem_init();
+       $GLOBALS['wfpl_template']->sub($sub_template_name);
+}
+
+function tem_load($filename) {
+       tem_init();
+       $GLOBALS['wfpl_template']->load($filename);
+}
+
+function tem_output($filename = false) {
+       tem_init();
+       $GLOBALS['wfpl_template']->output($filename);
+}
+
+
+
+function read_whole_file($name) {
+       $fd = fopen($name, 'r');
+       if($fd === false) {
+               die("Failed to read file: '$name'");
+       }
+       $temp = fread($fd, filesize($name));
+       fclose($fd);
+       return $temp;
+}
+
+# this is used in template_run() and should be of no other use
+function template_filler($matches) {
+       list($tag, $enc) = explode('.', $matches[1], 2);
+       $value = $GLOBALS['wfpl_template_keyval'][$tag];
+       if($enc) {
+               $enc = "enc_$enc";
+               if(function_exists($enc)) {
+                       $value = $enc($value);
+               } else {
+                       print "ERROR: encoder function '$enc' not found.<br>\n";
+                       exit(1);
+               }
+       }
+       return $value;
+}
+
+
+# pass a template string and an associative array of the key/values and it
+# returns the result.
+function template_run($template, &$keyval) {
+       $GLOBALS['wfpl_template_keyval'] =& $keyval;
+       return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);
+}
+
+
+?>
diff --git a/test/tem_test.php b/test/tem_test.php
new file mode 100644 (file)
index 0000000..dbe8d28
--- /dev/null
@@ -0,0 +1,78 @@
+<?php
+
+# Copyright (C) 2005 Jason Woofenden  PUBLIC DOMAIN
+
+
+# This file demonstrates, documents and tests the template system (along with
+# its html template.)
+
+# First we'll need the functions in wfpl/template.php:
+require_once('code/wfpl/template.php');
+# Always use the exact require_once statement above to get access to these
+# functions. You should have in each directory of your projects a copy of wfpl
+# or a symbolic link to it. This allows there to be different versions of wfpl
+# without changing the php for the site.
+
+# Now grab the template (you might want to take a look at this file)
+tem_load('tem_test.php.html');
+# This creates a template object to store all sorts of things, and then reads
+# in the template file and scans through it for sub-templates. Sub templates
+# are parts of the template that may appear any number of times in the output
+# (even zero times) such as a table row meant to hold a database record.
+
+# This is probably not the best example, but this template contains tables for
+# login, and for displaying some fake database content. For this silly example
+# I decide which I'm going to display by checking if the user has submitted a
+# username.
+if(!isset($_REQUEST['user'])) {
+       # tem_set() gives a key/value pair to template.php. When the template is
+       # output (or sub-templates are run with tem_sub) any occurences of ~user~
+       # will be replaced with 'bert'.
+       tem_set('user', 'bert');
+
+       # The template file contains a sub-template called 'login'. By default,
+       # sub-templates do not display at all. They display once for each time you
+       # call tem_sub()
+       tem_sub('login');
+
+       # This runs the template and prints the output. Running the template is
+       # simply replacing all ~key~ tags with the associated value. The values are
+       # set with tem_set() and tem_sub().
+       tem_output();
+
+       exit(0);
+}
+
+# Below is an example of using a sub-sub-template many times
+
+# first set some values to be displayed in the row:
+tem_set('foo', '*&^@$<>"');
+tem_set('bar', 'one*&^@$<>"');
+
+# Now run the row. This runs the sub-template for the row, and appends the data
+# for the 'foobar_row' entry in the main key/value list. 
+tem_sub('foobar_row');
+
+# and a couple more times:
+tem_set('foo', '"""""****"""""');
+tem_set('bar', 'two*&^"');
+tem_sub('foobar_row');
+tem_set('foo', '<<<<<<&&&&&&&&amp;>>>>>');
+tem_set('bar', 'threeeeeeee*&^@$<>"eeeeeeeeeeee');
+tem_sub('foobar_row');
+
+# Now we have a 'foobar_row' in the main keyval array with three rows of html in it.
+
+# in the template foobar_row is within a bigger sub-template called
+# 'foobar_table'. The only reason for this is so that we can have that table
+# not display at all when we're displaying the login. This is a silly use of
+# the templates, but I wanted to demonstrate and test a simple use of a
+# sub-template within a sub-template.
+tem_sub('foobar_table');
+
+
+# Now run the main template (the body of the template file)
+tem_output();
+
+
+?>
diff --git a/test/tem_test.php.html b/test/tem_test.php.html
new file mode 100644 (file)
index 0000000..6da95d7
--- /dev/null
@@ -0,0 +1,96 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<!-- This file is an example template for wfpl/template.php. It contains two
+special things: sub-templates and template tags. -->
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title></title>
+</head>
+
+<body>
+  <h1>Template Test Page</h1>
+  
+  <!-- Here's the first special thing. This marks the begining of a
+  sub-template. It marks a section of template which the php can decide how
+  many times to display (including none.) -->
+  
+  <!--~login start~-->
+  <h3>Please Log In Below</h3>
+
+  <form method="get" action="tem_test.php">
+    <table summary="">
+      <tr>
+        <td>Username:</td>
+
+               <!-- Neatly tucked into the next line is a template tag. This will be
+               replaced with content from PHP. Every template tag has a name ("user"
+               in this case) which says which value from php goes here, and should
+               also have an encoding ("attr" in this case). It is important to always
+               use the correct encoding. If you are putting the value in an html
+               attribute, use "attr" if you are displaying it use "html", if you are
+               putting it in a text file or e-mail then leave the encoding off and
+               just put ~user~. -->
+
+        <td><input type="text" name="user" value="~user.attr~" /></td>
+      </tr>
+
+      <tr>
+        <td>Password:</td>
+
+        <!-- there's another template tag named pass -->
+
+        <td><input type="password" name="pass" value="~pass.attr~" /></td>
+      </tr>
+
+      <tr>
+        <td colspan="2"><input type="submit" value="Log In" /></td>
+      </tr>
+    </table>
+  </form>
+
+  <!-- and here's the mark for the end of the login sub-template. -->
+
+  <!--~end~-->
+
+
+  <!-- Now for a more complex example of sub-templates. This whole table is in
+  a sub-template so php can decide to display the whole bit or not. First the
+  marker for the begining of the sub-template -->
+
+  <!--~foobar_table start~-->
+  <h3>All your foobar:</h3>
+
+  <table summary="">
+    <tr>
+      <th>foo</th>
+
+      <th>bar</th>
+    </tr>
+
+       <!-- OK, here's the fun part. We want PHP to be able to display many rows
+       in this table, so we make a template with just one row, and mark that row
+       as a sub-template named foobar_row -->
+    
+    <!--~foobar_row start~-->
+    <tr>
+         <!-- sorry that the following tag looks a bit like a filename. It isn't.
+         It's simply asking PHP for a value called "foo" encoded as html -->
+      <td>~foo.html~</td>
+
+      <td><input value="~bar.attr~" /></td>
+    </tr>
+    <!-- Here's the end of foobar_row -->
+    <!--~end~-->
+
+    <tr>
+      <td></td>
+      
+      <td><input type="submit" /></td>
+    </tr>
+
+  </table>
+  <!-- and the end of foobar_table -->
+  <!--~end~-->
+</body>
+</html>