pax_global_header00006660000000000000000000000064117154711100014510gustar00rootroot0000000000000052 comment=0e20bb45bb19774b4a896c39cfc4ae6ee8bbb627 php-horde-form-1.0.6/000077500000000000000000000000001171547111000143435ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/000077500000000000000000000000001171547111000170275ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/doc/000077500000000000000000000000001171547111000175745ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/doc/Horde/000077500000000000000000000000001171547111000206355ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/doc/Horde/Form/000077500000000000000000000000001171547111000215405ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/doc/Horde/Form/COPYING000066400000000000000000000576461171547111000226150ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 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. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, 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 and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, 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 library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete 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 distribute a copy of this License along with the Library. 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 Library or any portion of it, thus forming a work based on the Library, 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) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, 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 Library, 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 Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you 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. If distribution of 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 satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be 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. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library 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. 9. 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 Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library 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 with this License. 11. 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 Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library 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 Library. 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. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library 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. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser 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 Library 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 Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, 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 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. 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 LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS php-horde-form-1.0.6/Horde_Form-1.0.6/lib/000077500000000000000000000000001171547111000175755ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/000077500000000000000000000000001171547111000206365ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form.php000066400000000000000000000635751171547111000222720ustar00rootroot00000000000000 * Copyright 2001-2012 Horde LLC (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.horde.org/licenses/lgpl21. * * @author Robert E. Coyle * @author Chuck Hagenbuch * @package Form */ class Horde_Form { protected $_name = ''; protected $_title = ''; protected $_extra = ''; protected $_vars; protected $_submit = array(); protected $_reset = false; protected $_errors = array(); protected $_submitted = null; public $_sections = array(); protected $_open_section = null; protected $_currentSection = array(); protected $_variables = array(); protected $_hiddenVariables = array(); protected $_useFormToken = true; protected $_autofilled = false; protected $_enctype = null; public $_help = false; function Horde_Form(&$vars, $title = '', $name = null) { if (empty($name)) { $name = Horde_String::lower(get_class($this)); } $this->_vars = &$vars; $this->_title = $title; $this->_name = $name; } function __construct($vars, $title = '', $name = null) { $this->Horde_Form($vars, $title, $name); } function &singleton($form, &$vars, $title = '', $name = null) { static $instances = array(); $signature = serialize(array($form, $vars, $title, $name)); if (!isset($instances[$signature])) { if (class_exists($form)) { $instances[$signature] = new $form($vars, $title, $name); } else { $instances[$signature] = new Horde_Form($vars, $title, $name); } } return $instances[$signature]; } function setVars(&$vars) { $this->_vars = &$vars; } function getVars() { return $this->_vars; } function getTitle() { return $this->_title; } function setTitle($title) { $this->_title = $title; } function getExtra() { return $this->_extra; } function setExtra($extra) { $this->_extra = $extra; } function getName() { return $this->_name; } /** * Sets or gets whether the form should be verified by tokens. * Tokens are used to verify that a form is only submitted once. * * @param boolean $token If specified, sets whether to use form tokens. * * @return boolean Whether form tokens are being used. */ function useToken($token = null) { if (!is_null($token)) { $this->_useFormToken = $token; } return $this->_useFormToken; } /** * Get the renderer for this form, either a custom renderer or the * standard one. * * To use a custom form renderer, your form class needs to * override this function: * * function &getRenderer() * { * $r = new CustomFormRenderer(); * return $r; * } * * * ... where CustomFormRenderer is the classname of the custom * renderer class, which should extend Horde_Form_Renderer. * * @param array $params A hash of renderer-specific parameters. * * @return object Horde_Form_Renderer The form renderer. */ function getRenderer($params = array()) { $renderer = new Horde_Form_Renderer($params); return $renderer; } /** * @throws Horde_Exception */ function getType($type, $params = array()) { if (strpos($type, ':') !== false) { list($app, $type) = explode(':', $type); $type_class = $app . '_Form_Type_' . $type; } else { $type_class = 'Horde_Form_Type_' . $type; } if (!class_exists($type_class)) { throw new Horde_Exception(sprintf('Nonexistant class "%s" for field type "%s"', $type_class, $type)); } $type_ob = new $type_class(); if (!$params) { $params = array(); } call_user_func_array(array($type_ob, 'init'), $params); return $type_ob; } function setSection($section = '', $desc = '', $image = '', $expanded = true) { $this->_currentSection = $section; if (!count($this->_sections) && !$this->getOpenSection()) { $this->setOpenSection($section); } $this->_sections[$section]['desc'] = $desc; $this->_sections[$section]['expanded'] = $expanded; $this->_sections[$section]['image'] = $image; } function getSectionDesc($section) { return $this->_sections[$section]['desc']; } function getSectionImage($section) { return $this->_sections[$section]['image']; } function setOpenSection($section) { $this->_vars->set('__formOpenSection', $section); } function getOpenSection() { return $this->_vars->get('__formOpenSection'); } function getSectionExpandedState($section, $boolean = false) { if ($boolean) { /* Only the boolean value is required. */ return $this->_sections[$section]['expanded']; } /* Need to return the values for use in styles. */ if ($this->_sections[$section]['expanded']) { return 'block'; } else { return 'none'; } } /** * TODO */ function &addVariable($humanName, $varName, $type, $required, $readonly = false, $description = null, $params = array()) { return $this->insertVariableBefore(null, $humanName, $varName, $type, $required, $readonly, $description, $params); } /** * TODO */ function &insertVariableBefore($before, $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = array()) { $type = &$this->getType($type, $params); $var = new Horde_Form_Variable($humanName, $varName, $type, $required, $readonly, $description); /* Set the form object reference in the var. */ $var->setFormOb($this); if ($var->getTypeName() == 'enum' && !strlen($type->getPrompt()) && count($var->getValues()) == 1) { $vals = array_keys($var->getValues()); $this->_vars->add($var->varName, $vals[0]); $var->_autofilled = true; } elseif ($var->getTypeName() == 'file' || $var->getTypeName() == 'image') { $this->_enctype = 'multipart/form-data'; } if (empty($this->_currentSection) && $this->_currentSection !== 0) { $this->_currentSection = '__base'; } if (is_null($before)) { $this->_variables[$this->_currentSection][] = &$var; } else { $num = 0; while (isset($this->_variables[$this->_currentSection][$num]) && $this->_variables[$this->_currentSection][$num]->getVarName() != $before) { $num++; } if (!isset($this->_variables[$this->_currentSection][$num])) { $this->_variables[$this->_currentSection][] = &$var; } else { $this->_variables[$this->_currentSection] = array_merge( array_slice($this->_variables[$this->_currentSection], 0, $num), array(&$var), array_slice($this->_variables[$this->_currentSection], $num)); } } return $var; } /** * Removes a variable from the form. * * As only variables can be passed by reference, you need to call this * method this way if want to pass a variable name: * * $form->removeVariable($var = 'varname'); * * * @param Horde_Form_Variable|string $var Either the variable's name or * the variable to remove from the * form. * * @return boolean True if the variable was found (and deleted). */ function removeVariable(&$var) { foreach (array_keys($this->_variables) as $section) { foreach (array_keys($this->_variables[$section]) as $i) { if ((is_a($var, 'Horde_Form_Variable') && $this->_variables[$section][$i] === $var) || ($this->_variables[$section][$i]->getVarName() == $var)) { // Slice out the variable to be removed. $this->_variables[$this->_currentSection] = array_merge( array_slice($this->_variables[$this->_currentSection], 0, $i), array_slice($this->_variables[$this->_currentSection], $i + 1)); return true; } } } return false; } /** * TODO */ function &addHidden($humanName, $varName, $type, $required, $readonly = false, $description = null, $params = array()) { $type = &$this->getType($type, $params); $var = new Horde_Form_Variable($humanName, $varName, $type, $required, $readonly, $description); $var->hide(); $this->_hiddenVariables[] = &$var; return $var; } function &getVariables($flat = true, $withHidden = false) { if ($flat) { $vars = array(); foreach ($this->_variables as $section) { foreach ($section as $var) { $vars[] = $var; } } if ($withHidden) { foreach ($this->_hiddenVariables as $var) { $vars[] = $var; } } return $vars; } else { return $this->_variables; } } function setButtons($submit, $reset = false) { if ($submit === true || is_null($submit) || empty($submit)) { /* Default to 'Submit'. */ $submit = array(Horde_Form_Translation::t("Submit")); } elseif (!is_array($submit)) { /* Default to array if not passed. */ $submit = array($submit); } /* Only if $reset is strictly true insert default 'Reset'. */ if ($reset === true) { $reset = Horde_Form_Translation::t("Reset"); } $this->_submit = $submit; $this->_reset = $reset; } function appendButtons($submit) { if (!is_array($submit)) { $submit = array($submit); } $this->_submit = array_merge($this->_submit, $submit); } function preserveVarByPost(&$vars, $varname, $alt_varname = '') { $value = $vars->getExists($varname, $wasset); /* If an alternate name is given under which to preserve use that. */ if ($alt_varname) { $varname = $alt_varname; } if ($wasset) { $this->_preserveVarByPost($varname, $value); } } /** * @access private */ function _preserveVarByPost($varname, $value) { if (is_array($value)) { foreach ($value as $id => $val) { $this->_preserveVarByPost($varname . '[' . $id . ']', $val); } } else { $varname = htmlspecialchars($varname); $value = htmlspecialchars($value); printf('' . "\n", $varname, $value); } } function open(&$renderer, &$vars, $action, $method = 'get', $enctype = null) { if (is_null($enctype) && !is_null($this->_enctype)) { $enctype = $this->_enctype; } $renderer->open($action, $method, $this->_name, $enctype); $renderer->listFormVars($this); if (!empty($this->_name)) { $this->_preserveVarByPost('formname', $this->_name); } if ($this->_useFormToken) { $token = Horde_Token::generateId($this->_name); $GLOBALS['session']->set('horde', 'form_secrets/' . $token, true); $this->_preserveVarByPost($this->_name . '_formToken', $token); } /* Loop through vars and check for any special cases to preserve. */ $variables = $this->getVariables(); foreach ($variables as $var) { /* Preserve value if change has to be tracked. */ if ($var->getOption('trackchange')) { $varname = $var->getVarName(); $this->preserveVarByPost($vars, $varname, '__old_' . $varname); } } foreach ($this->_hiddenVariables as $var) { $this->preserveVarByPost($vars, $var->getVarName()); } } function close($renderer) { $renderer->close(); } /** * Renders the form for editing. * * @param Horde_Form_Renderer $renderer A renderer instance, optional * since Horde 3.2. * @param Variables $vars A Variables instance, optional * since Horde 3.2. * @param string $action The form action (url). * @param string $method The form method, usually either * 'get' or 'post'. * @param string $enctype The form encoding type. Determined * automatically if null. * @param boolean $focus Focus the first form field? */ function renderActive($renderer = null, $vars = null, $action = '', $method = 'get', $enctype = null, $focus = true) { if (is_null($renderer)) { $renderer = $this->getRenderer(); } if (is_null($vars)) { $vars = $this->_vars; } if (is_null($enctype) && !is_null($this->_enctype)) { $enctype = $this->_enctype; } $renderer->open($action, $method, $this->getName(), $enctype); $renderer->listFormVars($this); if (!empty($this->_name)) { $this->_preserveVarByPost('formname', $this->_name); } if ($this->_useFormToken) { $token = Horde_Token::generateId($this->_name); $GLOBALS['session']->set('horde', 'form_secrets/' . $token, true); $this->_preserveVarByPost($this->_name . '_formToken', $token); } if (count($this->_sections)) { $this->_preserveVarByPost('__formOpenSection', $this->getOpenSection()); } /* Loop through vars and check for any special cases to * preserve. */ $variables = $this->getVariables(); foreach ($variables as $var) { /* Preserve value if change has to be tracked. */ if ($var->getOption('trackchange')) { $varname = $var->getVarName(); $this->preserveVarByPost($vars, $varname, '__old_' . $varname); } } foreach ($this->_hiddenVariables as $var) { $this->preserveVarByPost($vars, $var->getVarName()); } $renderer->beginActive($this->getTitle(), $this->getExtra()); $renderer->renderFormActive($this, $vars); $renderer->submit($this->_submit, $this->_reset); $renderer->end(); $renderer->close($focus); } /** * Renders the form for displaying. * * @param Horde_Form_Renderer $renderer A renderer instance, optional * since Horde 3.2. * @param Variables $vars A Variables instance, optional * since Horde 3.2. */ function renderInactive($renderer = null, $vars = null) { if (is_null($renderer)) { $renderer = $this->getRenderer(); } if (is_null($vars)) { $vars = $this->_vars; } $renderer->_name = $this->_name; $renderer->beginInactive($this->getTitle(), $this->getExtra()); $renderer->renderFormInactive($this, $vars); $renderer->end(); } function preserve($vars) { if ($this->_useFormToken) { $token = Horde_Token::generateId($this->_name); $GLOBALS['session']->set('horde', 'form_secrets/' . $token, true); $this->_preserveVarByPost($this->_name . '_formToken', $token); } $variables = $this->getVariables(); foreach ($variables as $var) { $varname = $var->getVarName(); /* Save value of individual components. */ switch ($var->getTypeName()) { case 'passwordconfirm': case 'emailconfirm': $this->preserveVarByPost($vars, $varname . '[original]'); $this->preserveVarByPost($vars, $varname . '[confirm]'); break; case 'monthyear': $this->preserveVarByPost($vars, $varname . '[month]'); $this->preserveVarByPost($vars, $varname . '[year]'); break; case 'monthdayyear': $this->preserveVarByPost($vars, $varname . '[month]'); $this->preserveVarByPost($vars, $varname . '[day]'); $this->preserveVarByPost($vars, $varname . '[year]'); break; } $this->preserveVarByPost($vars, $varname); } foreach ($this->_hiddenVariables as $var) { $this->preserveVarByPost($vars, $var->getVarName()); } } function unsetVars(&$vars) { foreach ($this->getVariables() as $var) { $vars->remove($var->getVarName()); } } /** * Validates the form, checking if it really has been submitted by calling * isSubmitted() and if true does any onSubmit() calls for variable types * in the form. The _submitted variable is then rechecked. * * @param Variables $vars A Variables instance, optional since Horde * 3.2. * @param boolean $canAutofill Can the form be valid without being * submitted? * * @return boolean True if the form is valid. */ function validate($vars = null, $canAutoFill = false) { if (is_null($vars)) { $vars = $this->_vars; } /* Get submitted status. */ if ($this->isSubmitted() || $canAutoFill) { /* Form was submitted or can autofill; check for any variable * types' onSubmit(). */ $this->onSubmit($vars); /* Recheck submitted status. */ if (!$this->isSubmitted() && !$canAutoFill) { return false; } } else { /* Form has not been submitted; return false. */ return false; } $message = ''; $this->_autofilled = true; if ($this->_useFormToken) { $tokenSource = $GLOBALS['injector']->getInstance('Horde_Token'); $passedToken = $vars->get($this->_name . '_formToken'); if (!empty($passedToken) && !$tokenSource->verify($passedToken)) { $this->_errors['_formToken'] = Horde_Form_Translation::t("This form has already been processed."); } if (!$GLOBALS['session']->get('horde', 'form_secrets/' . $passedToken)) { $this->_errors['_formSecret'] = Horde_Form_Translation::t("Required secret is invalid - potentially malicious request."); } } foreach ($this->getVariables() as $var) { $this->_autofilled = $var->_autofilled && $this->_autofilled; if (!$var->validate($vars, $message)) { $this->_errors[$var->getVarName()] = $message; } } if ($this->_autofilled) { unset($this->_errors['_formToken']); } foreach ($this->_hiddenVariables as $var) { if (!$var->validate($vars, $message)) { $this->_errors[$var->getVarName()] = $message; } } return $this->isValid(); } function clearValidation() { $this->_errors = array(); } function getErrors() { return $this->_errors; } function getError($var) { if (is_a($var, 'Horde_Form_Variable')) { $name = $var->getVarName(); } else { $name = $var; } return isset($this->_errors[$name]) ? $this->_errors[$name] : null; } function setError($var, $message) { if (is_a($var, 'Horde_Form_Variable')) { $name = $var->getVarName(); } else { $name = $var; } $this->_errors[$name] = $message; } function clearError($var) { if (is_a($var, 'Horde_Form_Variable')) { $name = $var->getVarName(); } else { $name = $var; } unset($this->_errors[$name]); } function isValid() { return ($this->_autofilled || count($this->_errors) == 0); } function execute() { Horde::logMessage('Warning: Horde_Form::execute() called, should be overridden', 'DEBUG'); } /** * Fetch the field values of the submitted form. * * @param Variables $vars A Variables instance, optional since Horde 3.2. * @param array $info Array to be filled with the submitted field * values. */ function getInfo($vars, &$info) { if (is_null($vars)) { $vars = $this->_vars; } $this->_getInfoFromVariables($this->getVariables(), $vars, $info); $this->_getInfoFromVariables($this->_hiddenVariables, $vars, $info); } /** * Fetch the field values from a given array of variables. * * @access private * * @param array $variables An array of Horde_Form_Variable objects to * fetch from. * @param object $vars The Variables object. * @param array $info The array to be filled with the submitted * field values. */ function _getInfoFromVariables($variables, &$vars, &$info) { foreach ($variables as $var) { if ($var->isArrayVal()) { $var->getInfo($vars, $values); if (is_array($values)) { $varName = str_replace('[]', '', $var->getVarName()); foreach ($values as $i => $val) { $info[$i][$varName] = $val; } } } else { if (Horde_Array::getArrayParts($var->getVarName(), $base, $keys)) { if (!isset($info[$base])) { $info[$base] = array(); } $pointer = &$info[$base]; while (count($keys)) { $key = array_shift($keys); if (!isset($pointer[$key])) { $pointer[$key] = array(); } $pointer = &$pointer[$key]; } $var->getInfo($vars, $pointer); } else { $var->getInfo($vars, $info[$var->getVarName()]); } } } } function hasHelp() { return $this->_help; } /** * Determines if this form has been submitted or not. If the class * var _submitted is null then it will check for the presence of * the formname in the form variables. * * Other events can explicitly set the _submitted variable to * false to indicate a form submit but not for actual posting of * data (eg. onChange events to update the display of fields). * * @return boolean True or false indicating if the form has been * submitted. */ function isSubmitted() { if (is_null($this->_submitted)) { if ($this->_vars->get('formname') == $this->getName()) { $this->_submitted = true; } else { $this->_submitted = false; } } return $this->_submitted; } /** * Checks if there is anything to do on the submission of the form by * looping through each variable's onSubmit() function. * * @param Horde_Variables $vars */ function onSubmit(&$vars) { /* Loop through all vars and check if there's anything to do on * submit. */ $variables = $this->getVariables(); foreach ($variables as $var) { $var->type->onSubmit($var, $vars); /* If changes to var being tracked don't register the form as * submitted if old value and new value differ. */ if ($var->getOption('trackchange')) { $varname = $var->getVarName(); if (!is_null($vars->get('formname')) && $vars->get($varname) != $vars->get('__old_' . $varname)) { $this->_submitted = false; } } } } /** * Explicitly sets the state of the form submit. * * An event can override the automatic determination of the submit state * in the isSubmitted() function. * * @param boolean $state Whether to set the state of the form as being * submitted. */ function setSubmitted($state = true) { $this->_submitted = $state; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/000077500000000000000000000000001171547111000215415ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action.php000066400000000000000000000076171171547111000235020ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action { var $_id; var $_params; var $_trigger = null; function Horde_Form_Action($params = null) { $this->_params = $params; $this->_id = md5(mt_rand()); } function getTrigger() { return $this->_trigger; } function id() { return $this->_id; } function getActionScript($form, $renderer, $varname) { return ''; } function printJavaScript() { } function _printJavaScriptStart() { echo ''; } function getTarget() { return isset($this->_params['target']) ? $this->_params['target'] : null; } function setValues(&$vars, $sourceVal, $index = null, $arrayVal = false) { } /** * Attempts to return a concrete Horde_Form_Action instance * based on $form. * * @param mixed $action The type of concrete Horde_Form_Action subclass * to return. If $action is an array, then we will look * in $action[0]/lib/Form/Action/ for the subclass * implementation named $action[1].php. * @param array $params A hash containing any additional configuration a * form might need. * * @return Horde_Form_Action The concrete Horde_Form_Action reference, or * false on an error. */ function &factory($action, $params = null) { if (is_array($action)) { $app = $action[0]; $action = $action[1]; } $action = basename($action); $class = 'Horde_Form_Action_' . $action; if (!class_exists($class)) { if (!empty($app)) { include_once $GLOBALS['registry']->get('fileroot', $app) . '/lib/Form/Action/' . $action . '.php'; } } if (class_exists($class)) { $instance = new $class($params); } else { $instance = PEAR::raiseError('Class definition of ' . $class . ' not found.'); } return $instance; } /** * Attempts to return a reference to a concrete * Horde_Form_Action instance based on $action. It will only * create a new instance if no Horde_Form_Action instance with * the same parameters currently exists. * * This should be used if multiple types of form renderers (and, * thus, multiple Horde_Form_Action instances) are required. * * This method must be invoked as: $var = * &Horde_Form_Action::singleton() * * @param mixed $action The type of concrete Horde_Form_Action subclass to return. * The code is dynamically included. If $action is an array, * then we will look in $action[0]/lib/Form/Action/ for * the subclass implementation named $action[1].php. * @param array $params A hash containing any additional configuration a * form might need. * * @return Horde_Form_Action The concrete Horde_Form_Action reference, or * false on an error. */ function &singleton($action, $params = null) { static $instances = array(); $signature = serialize(array($action, $params)); if (!isset($instances[$signature])) { $instances[$signature] = &Horde_Form_Action::factory($action, $params); } return $instances[$signature]; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/000077500000000000000000000000001171547111000227565ustar00rootroot00000000000000php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/ConditionalEnable.php000066400000000000000000000032541171547111000270450ustar00rootroot00000000000000 * $params = array( * 'target' => '[name of element this is conditional on]', * 'enabled' => 'true' | 'false', * 'values' => array([target values to check]) * ); * * * So $params = array('foo', 'true', array(1, 2)) will enable the field this * action is attached to if the value of 'foo' is 1 or 2, and disable it * otherwise. * * Copyright 2002-2012 Horde LLC (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.horde.org/licenses/lgpl21. * * @author Matt Kynaston * @package Form */ class Horde_Form_Action_ConditionalEnable extends Horde_Form_Action { var $_trigger = array('onload'); function getActionScript(&$form, $renderer, $varname) { Horde::addScriptFile('form_helpers.js', 'horde'); $form_name = $form->getName(); $target = $this->_params['target']; $enabled = $this->_params['enabled']; if (!is_string($enabled)) { $enabled = ($enabled) ? 'true' : 'false'; } $vals = $this->_params['values']; $vals = (is_array($vals)) ? $vals : array($vals); $args = "'$varname', $enabled, '" . implode("','", $vals) . "'"; return "if (addEvent(document.getElementById('$form_name').$target, 'onchange', \"checkEnabled(this, $args);\")) { " . " checkEnabled(document.getElementById('$form_name').$varname, $args); };"; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/ConditionalSetValue.php000066400000000000000000000046121171547111000274060ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_ConditionalSetValue extends Horde_Form_Action { /** * Which JS events should trigger this action? * * @var array */ var $_trigger = array('onchange', 'onload'); function getActionScript($form, $renderer, $varname) { return 'map(\'' . $renderer->_genID($varname, false) . "', '" . $renderer->_genID($this->getTarget(), false) . '\');'; } function setValues(&$vars, $sourceVal, $arrayVal = false) { $map = $this->_params['map']; $target = $this->getTarget(); if ($arrayVal) { $i = 0; if (is_array($sourceVal)) { foreach ($sourceVal as $val) { if (!empty($map[$val])) { $vars->set($target, $map[$val], $i); } $i++; } } } else { if (!empty($map[$sourceVal])) { $vars->set($target, $map[$sourceVal]); } } } function printJavaScript() { $this->_printJavaScriptStart(); $map = $this->_params['map']; ?> var _map = [ 0) { echo ', '; } echo '"' . $val . '"'; $i++; }?>]; function map(sourceId, targetId) { var newval; var source = document.getElementById(sourceId); var element = document.getElementById(targetId); if (element) { if (_map[source.selectedIndex]) { newval = _map[source.selectedIndex]; replace = true; } else { newval = ''; replace = false; for (i = 0; i < _map.length; i++) { if (element.value == _map[i]) { replace = true; break; } } } if (replace) { element.value = newval; } } }_printJavaScriptEnd(); } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/conditional_enable.php000066400000000000000000000032561171547111000273060ustar00rootroot00000000000000 * $params = array( * 'target' => '[name of element this is conditional on]', * 'enabled' => 'true' | 'false', * 'values' => array([target values to check]) * ); * * * So $params = array('foo', 'true', array(1, 2)) will enable the field this * action is attached to if the value of 'foo' is 1 or 2, and disable it * otherwise. * * Copyright 2002-2012 Horde LLC (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.horde.org/licenses/lgpl21. * * @author Matt Kynaston * @package Form */ class Horde_Form_Action_conditional_enable extends Horde_Form_Action { var $_trigger = array('onload'); function getActionScript(&$form, $renderer, $varname) { Horde::addScriptFile('form_helpers.js', 'horde'); $form_name = $form->getName(); $target = $this->_params['target']; $enabled = $this->_params['enabled']; if (!is_string($enabled)) { $enabled = ($enabled) ? 'true' : 'false'; } $vals = $this->_params['values']; $vals = (is_array($vals)) ? $vals : array($vals); $args = "'$varname', $enabled, '" . implode("','", $vals) . "'"; return "if (addEvent(document.getElementById('$form_name').$target, 'onchange', \"checkEnabled(this, $args);\")) { " . " checkEnabled(document.getElementById('$form_name').$varname, $args); };"; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/conditional_setvalue.php000066400000000000000000000046141171547111000277070ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_conditional_setvalue extends Horde_Form_Action { /** * Which JS events should trigger this action? * * @var array */ var $_trigger = array('onchange', 'onload'); function getActionScript($form, $renderer, $varname) { return 'map(\'' . $renderer->_genID($varname, false) . "', '" . $renderer->_genID($this->getTarget(), false) . '\');'; } function setValues(&$vars, $sourceVal, $arrayVal = false) { $map = $this->_params['map']; $target = $this->getTarget(); if ($arrayVal) { $i = 0; if (is_array($sourceVal)) { foreach ($sourceVal as $val) { if (!empty($map[$val])) { $vars->set($target, $map[$val], $i); } $i++; } } } else { if (!empty($map[$sourceVal])) { $vars->set($target, $map[$sourceVal]); } } } function printJavaScript() { $this->_printJavaScriptStart(); $map = $this->_params['map']; ?> var _map = [ 0) { echo ', '; } echo '"' . $val . '"'; $i++; }?>]; function map(sourceId, targetId) { var newval; var source = document.getElementById(sourceId); var element = document.getElementById(targetId); if (element) { if (_map[source.selectedIndex]) { newval = _map[source.selectedIndex]; replace = true; } else { newval = ''; replace = false; for (i = 0; i < _map.length; i++) { if (element.value == _map[i]) { replace = true; break; } } } if (replace) { element.value = newval; } } }_printJavaScriptEnd(); } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/reload.php000066400000000000000000000016061171547111000247400ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_reload extends Horde_Form_Action { var $_trigger = array('onchange'); function getActionScript($form, $renderer, $varname) { Horde::addScriptFile('effects.js', 'horde'); Horde::addScriptFile('redbox.js', 'horde'); return 'if (this.value) { document.' . $form->getName() . '.formname.value=\'\'; RedBox.loading(); document.' . $form->getName() . '.submit() }'; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/setcursorpos.php000066400000000000000000000016351171547111000262470ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_setcursorpos extends Horde_Form_Action { var $_trigger = array('onload'); function getActionScript(&$form, $renderer, $varname) { Horde::addScriptFile('form_helpers.js', 'horde'); $pos = implode(',', $this->_params); return 'form_setCursorPosition(document.forms[\'' . htmlspecialchars($form->getName()) . '\'].elements[\'' . htmlspecialchars($varname) . '\'].id, ' . $pos . ');'; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/submit.php000066400000000000000000000014251171547111000247740ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_submit extends Horde_Form_Action { var $_trigger = array('onchange'); function getActionScript($form, $renderer, $varname) { Horde::addScriptFile('effects.js', 'horde'); Horde::addScriptFile('redbox.js', 'horde'); return 'RedBox.loading(); document.' . $form->getName() . '.submit()'; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/sum_fields.php000066400000000000000000000026061171547111000256250ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_sum_fields extends Horde_Form_Action { var $_trigger = array('onload'); function getActionScript(&$form, $renderer, $varname) { Horde::addScriptFile('form_helpers.js', 'horde'); $form_name = $form->getName(); $fields = "'" . implode("','", $this->_params) . "'"; $js = array(); $js[] = sprintf('document.forms[\'%s\'].elements[\'%s\'].disabled = true;', $form_name, $varname); foreach ($this->_params as $field) { $js[] = sprintf("addEvent(document.forms['%1\$s'].elements['%2\$s'], \"onchange\", \"sumFields(document.forms['%1\$s'], '%3\$s', %4\$s);\");", $form_name, $field, $varname, $fields); } return implode("\n", $js); } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Action/updatefield.php000066400000000000000000000036071171547111000257630ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Action_updatefield extends Horde_Form_Action { var $_trigger = array('onchange', 'onload', 'onkeyup'); function getActionScript(&$form, &$renderer, $varname) { return 'updateField' . $this->id() . '();'; } function setValues(&$vars, $sourceVal, $arrayVal = false) { } function printJavaScript() { $this->_printJavaScriptStart(); $pieces = explode('%s', $this->_params['format']); $fields = $this->_params['fields']; $val_first = (substr($this->_params['format'], 0, 2) == '%s'); if ($val_first) { array_shift($pieces); } if (substr($this->_params['format'], -2) == '%s') { array_pop($pieces); } $args = array(); if ($val_first) { $args[] = "document.getElementById('" . array_shift($fields) . "').value"; } while (count($pieces)) { $args[] = "'" . array_shift($pieces) . "'"; $args[] = "document.getElementById('" . array_shift($fields) . "').value"; } ?> // Updater for getTarget() ?>. function updateFieldid() ?>() { var target = document.getElementById('getTarget() ?>'); if (target) { target.value = ().replace(/(^ +| +$)/, '').replace(/ +/g, ' '); } }_printJavaScriptEnd(); } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Renderer.php000066400000000000000000000436211171547111000240260ustar00rootroot00000000000000 * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.horde.org/licenses/lgpl21. * * @author Robert E. Coyle * @package Form */ class Horde_Form_Renderer { var $_name; var $_requiredLegend = false; var $_requiredMarker = '*'; var $_helpMarker = '?'; var $_showHeader = true; var $_cols = 2; var $_varRenderer = null; var $_firstField = null; var $_stripedRows = true; /** * Does the title of the form contain HTML? If so, you are responsible for * doing any needed escaping/sanitization yourself. Otherwise the title * will be run through htmlspecialchars() before being output. * * @var boolean */ var $_encodeTitle = true; /** * Width of the attributes column. * * @access private * @var string */ var $_attrColumnWidth = '15%'; /** * Construct a new Horde_Form_Renderer::. * * @param array $params This is a hash of renderer-specific parameters. * Possible keys: * - 'varrenderer_driver': specifies the driver * parameter to Horde_Core_Ui_VarRenderer::factory(). * - 'encode_title': @see $_encodeTitle */ function Horde_Form_Renderer($params = array()) { global $registry; if (isset($registry) && is_a($registry, 'Registry')) { /* Registry available, so use a pretty image. */ $this->_requiredMarker = Horde::img('required.png', '*'); } else { /* No registry available, use something plain. */ $this->_requiredMarker = '*'; } if (isset($params['encode_title'])) { $this->encodeTitle($params['encode_title']); } $driver = 'html'; if (isset($params['varrenderer_driver'])) { $driver = $params['varrenderer_driver']; } $this->_varRenderer = Horde_Core_Ui_VarRenderer::factory($driver, $params); } function showHeader($bool) { $this->_showHeader = $bool; } /** * Sets or returns whether the form title should be encoded with * htmlspecialchars(). * * @param boolean $encode If true, the form title gets encoded. If false * the title can contain HTML, but the class user * is responsible to encode any special characters. * * @return boolean Whether the form title should be encoded. */ function encodeTitle($encode = null) { if (!is_null($encode)) { $this->_encodeTitle = $encode; } return $this->_encodeTitle = $encode; } /** * @deprecated */ function setAttrColumnWidth($width) { } function open($action, $method, $name, $enctype = null) { $this->_name = $name; $name = htmlspecialchars($name); $action = htmlspecialchars($action); $method = htmlspecialchars($method); echo "
\n"; Horde_Util::pformInput(); } function beginActive($name, $extra = null) { $this->_renderBeginActive($name, $extra); } function beginInactive($name, $extra = null) { $this->_renderBeginInactive($name, $extra); } function _renderSectionTabs(&$form) { /* If javascript is not available, do not render tabs. */ if (!$GLOBALS['browser']->hasFeature('javascript')) { return; } $open_section = $form->getOpenSection(); /* Add the javascript for the toggling the sections. */ Horde::addScriptFile('form_sections.js', 'horde'); echo ''; /* Loop through the sections and print out a tab for each. */ echo "
    \n"; foreach ($form->_sections as $section => $val) { $class = ($section == $open_section) ? ' class="activeTab"' : ''; $js = sprintf('onclick="sections_%s.toggle(\'%s\'); return false;"', $form->getName(), $section); printf('%s%s ' . "\n", $class, htmlspecialchars($form->getName() . '_tab_' . $section), $js, $form->getSectionImage($section), $form->getSectionDesc($section)); } echo "

\n"; } function _renderSectionBegin(&$form, $section) { // Stripe alternate rows if that option is turned on. if ($this->_stripedRows && class_exists('Horde')) { Horde::addScriptFile('stripe.js', 'horde'); $class = ' class="striped"'; } else { $class = ''; } $open_section = $form->getOpenSection(); if (is_null($open_section)) { $open_section = '__base'; } printf('
', htmlspecialchars($form->getName() . '_section_' . $section), ($open_section == $section ? 'block' : 'none'), $class); } function _renderSectionEnd() { echo '
'; } function end() { $this->_renderEnd(); } function close($focus = true) { echo "
\n"; if ($focus && !empty($this->_firstField)) { echo ' '; } } function listFormVars(&$form) { $variables = &$form->getVariables(true, true); $vars = array(); if ($variables) { foreach ($variables as $var) { if (is_object($var)) { if (!$var->isReadonly()) { $vars[$var->getVarName()] = 1; } } else { $vars[$var] = 1; } } } echo ''; } function renderFormActive(&$form, &$vars) { $this->_renderForm($form, $vars, true); } function renderFormInactive(&$form, &$vars) { $this->_renderForm($form, $vars, false); } function _renderForm(&$form, &$vars, $active) { /* If help is present 3 columns are needed. */ $this->_cols = $form->hasHelp() ? 3 : 2; $variables = &$form->getVariables(false); /* Check for a form token error. */ if (($tokenError = $form->getError('_formToken')) !== null) { echo '

' . htmlspecialchars($tokenError) . '

'; } /* Check for a form secret error. */ if (($secretError = $form->getError('_formSecret')) !== null) { echo '

' . htmlspecialchars($secretError) . '

'; } if (count($form->_sections)) { $this->_renderSectionTabs($form); } $error_section = null; foreach ($variables as $section_id => $section) { $this->_renderSectionBegin($form, $section_id); foreach ($section as $var) { $type = $var->getTypeName(); switch ($type) { case 'header': $this->_renderHeader($var->getHumanName(), $form->getError($var->getVarName())); break; case 'description': $this->_renderDescription($var->getHumanName()); break; case 'spacer': $this->_renderSpacer(); break; default: $isInput = ($active && !$var->isReadonly()); $format = $isInput ? 'Input' : 'Display'; $begin = "_renderVar${format}Begin"; $end = "_renderVar${format}End"; $this->$begin($form, $var, $vars); echo $this->_varRenderer->render($form, $var, $vars, $isInput); /* Print any javascript if actions present. */ if ($var->hasAction()) { $var->_action->printJavaScript(); } $this->$end($form, $var, $vars); /* Keep first field. */ if ($active && empty($this->_firstField) && !$var->isReadonly() && !$var->isHidden()) { $this->_firstField = $var->getVarName(); } /* Keep section with first error. */ if (is_null($error_section) && $form->getError($var)) { $error_section = $section_id; } } } $this->_renderSectionEnd(); } if (!is_null($error_section) && $form->_sections) { echo '"; } } function submit($submit = null, $reset = false) { if (is_null($submit) || empty($submit)) { $submit = Horde_Form_Translation::t("Submit"); } if ($reset === true) { $reset = Horde_Form_Translation::t("Reset"); } $this->_renderSubmit($submit, $reset); } /** * Implementation specific begin function. */ function _renderBeginActive($name, $extra) { echo '
'; if ($this->_showHeader) { $this->_sectionHeader($name, $extra); } if ($this->_requiredLegend) { echo '' . $this->_requiredMarker . ' = ' . Horde_Form_Translation::t("Required Field"); } } /** * Implementation specific begin function. */ function _renderBeginInactive($name, $extra) { echo '
'; if ($this->_showHeader) { $this->_sectionHeader($name, $extra); } } /** * Implementation specific end function. */ function _renderEnd() { echo '
' . $this->_varRenderer->renderEnd(); } function _renderHeader($header, $error = '') { ?>

 
getError($var); $isvalid = empty($message); echo "\n"; printf(' %s%s%s%s' . "\n", empty($this->_attrColumnWidth) ? '' : ' width="' . $this->_attrColumnWidth . '"', $isvalid ? '' : '', $var->isRequired() ? '' . $this->_requiredMarker . ' ' : '', $var->getHumanName(), $isvalid ? '' : '
' . $message . ''); printf(' ', ((!$var->hasHelp() && $form->hasHelp()) ? ' colspan="2"' : ''), ($var->isDisabled() ? ' class="form-disabled"' : '')); } function _renderVarInputEnd(&$form, &$var, &$vars) { /* Display any description for the field. */ if ($var->hasDescription()) { echo '
' . $var->getDescription(); } /* Display any help for the field. */ if ($var->hasHelp()) { global $registry; if (isset($registry) && $registry instanceof Horde_Registry) { $link = Horde_Help::link($GLOBALS['registry']->getApp(), $var->getHelp()); } else { $link = '' . $this->_helpMarker . ''; } echo "\n $link "; } echo "\n\n"; } // Implementation specifics -- display variables. function _renderVarDisplayBegin(&$form, &$var, &$vars) { $message = $form->getError($var); $isvalid = empty($message); echo "\n"; printf(' %s%s%s' . "\n", empty($this->_attrColumnWidth) ? '' : ' width="' . $this->_attrColumnWidth . '"', $isvalid ? '' : '', $var->getHumanName(), $isvalid ? '' : '
' . $message . ''); echo ' '; } function _renderVarDisplayEnd(&$form, &$var, &$vars) { if ($var->hasHelp()) { echo ' '; } echo "\n\n"; } function _sectionHeader($title, $extra = '') { if (strlen($title)) { echo '
'; if (!empty($extra)) { echo '' . $extra . ''; } echo $this->_encodeTitle ? htmlspecialchars($title) : $title; echo '
'; } } /** * Attempts to return a concrete Horde_Form_Renderer instance based on * $renderer. * * @param mixed $renderer The type of concrete Horde_Form_Renderer * subclass to return. The code is dynamically * included. If $renderer is an array, then we will * look in $renderer[0]/lib/Form/Renderer/ for the * subclass implementation named $renderer[1].php. * @param array $params A hash containing any additional configuration a * form might need. * * @return Horde_Form_Renderer The concrete Horde_Form_Renderer reference, * or false on an error. */ function factory($renderer = '', $params = null) { if (is_array($renderer)) { $app = $renderer[0]; $renderer = $renderer[1]; } /* Return a base Horde_Form_Renderer object if no driver is * specified. */ $renderer = basename($renderer); if (!empty($renderer) && $renderer != 'none') { $class = 'Horde_Form_Renderer_' . $renderer; } else { $class = 'Horde_Form_Renderer'; } if (!class_exists($class)) { if (!empty($app)) { include $GLOBALS['registry']->get('fileroot', $app) . '/lib/Form/Renderer/' . $renderer . '.php'; } else { include 'Horde/Form/Renderer/' . $renderer . '.php'; } } if (class_exists($class)) { return new $class($params); } else { return PEAR::raiseError('Class definition of ' . $class . ' not found.'); } } /** * Attempts to return a reference to a concrete Horde_Form_Renderer * instance based on $renderer. It will only create a new instance if no * Horde_Form_Renderer instance with the same parameters currently exists. * * This should be used if multiple types of form renderers (and, * thus, multiple Horde_Form_Renderer instances) are required. * * This method must be invoked as: $var = &Horde_Form_Renderer::singleton() * * @param mixed $renderer The type of concrete Horde_Form_Renderer * subclass to return. The code is dynamically * included. If $renderer is an array, then we will * look in $renderer[0]/lib/Form/Renderer/ for the * subclass implementation named $renderer[1].php. * @param array $params A hash containing any additional configuration a * form might need. * * @return Horde_Form_Renderer The concrete Horde_Form_Renderer reference, * or false on an error. */ function &singleton($renderer, $params = null) { static $instances = array(); $signature = serialize(array($renderer, $params)); if (!isset($instances[$signature])) { $instances[$signature] = Horde_Form_Renderer::factory($renderer, $params); } return $instances[$signature]; } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Translation.php000066400000000000000000000032251171547111000245520ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Translation extends Horde_Translation { /** * Returns the translation of a message. * * @var string $message The string to translate. * * @return string The string translation, or the original string if no * translation exists. */ static public function t($message) { self::$_domain = 'Horde_Form'; self::$_directory = '@data_dir@' == '@'.'data_dir'.'@' ? dirname(__FILE__) . '/../../../locale' : '@data_dir@/Horde_Form/locale'; return parent::t($message); } /** * Returns the plural translation of a message. * * @param string $singular The singular version to translate. * @param string $plural The plural version to translate. * @param integer $number The number that determines singular vs. plural. * * @return string The string translation, or the original string if no * translation exists. */ static public function ngettext($singular, $plural, $number) { self::$_domain = 'Horde_Form'; self::$_directory = '@data_dir@' == '@'.'data_dir'.'@' ? dirname(__FILE__) . '/../../../locale' : '@data_dir@/Horde_Form/locale'; return parent::ngettext($singular, $plural, $number); } } php-horde-form-1.0.6/Horde_Form-1.0.6/lib/Horde/Form/Type.php000066400000000000000000003403421171547111000232010ustar00rootroot00000000000000 * @package Form */ class Horde_Form_Type { function getProperty($property) { $prop = '_' . $property; return isset($this->$prop) ? $this->$prop : null; } function __get($property) { return $this->getProperty($property); } function setProperty($property, $value) { $prop = '_' . $property; $this->$prop = $value; } function __set($property, $value) { return $this->setProperty($property, $value); } function init() { } function onSubmit() { } function isValid(&$var, &$vars, $value, &$message) { $message = 'Error: Horde_Form_Type::isValid() called - should be overridden
'; return false; } function getTypeName() { return str_replace('horde_form_type_', '', Horde_String::lower(get_class($this))); } function getValues() { return null; } function getInfo(&$vars, &$var, &$info) { $info = $var->getValue($vars); } } class Horde_Form_Type_spacer extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Spacer")); } } class Horde_Form_Type_header extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Header")); } } class Horde_Form_Type_description extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Description")); } } /** * Simply renders its raw value in both active and inactive rendering. */ class Horde_Form_Type_html extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("HTML")); } } class Horde_Form_Type_number extends Horde_Form_Type { var $_fraction; function init($fraction = null) { $this->_fraction = $fraction; } function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value) && ((string)(double)$value !== $value)) { $message = Horde_Form_Translation::t("This field is required."); return false; } elseif (empty($value)) { return true; } /* If matched, then this is a correct numeric value. */ if (preg_match($this->_getValidationPattern(), $value)) { return true; } $message = Horde_Form_Translation::t("This field must be a valid number."); return false; } function _getValidationPattern() { static $pattern = ''; if (!empty($pattern)) { return $pattern; } /* Get current locale information. */ $linfo = Horde_Nls::getLocaleInfo(); /* Build the pattern. */ $pattern = '(-)?'; /* Only check thousands separators if locale has any. */ if (!empty($linfo['mon_thousands_sep'])) { /* Regex to check for correct thousands separators (if any). */ $pattern .= '((\d+)|((\d{0,3}?)([' . $linfo['mon_thousands_sep'] . ']\d{3})*?))'; } else { /* No locale thousands separator, check for only digits. */ $pattern .= '(\d+)'; } /* If no decimal point specified default to dot. */ if (empty($linfo['mon_decimal_point'])) { $linfo['mon_decimal_point'] = '.'; } /* Regex to check for correct decimals (if any). */ if (empty($this->_fraction)) { $fraction = '*'; } else { $fraction = '{0,' . $this->_fraction . '}'; } $pattern .= '([' . $linfo['mon_decimal_point'] . '](\d' . $fraction . '))?'; /* Put together the whole regex pattern. */ $pattern = '/^' . $pattern . '$/'; return $pattern; } function getInfo(&$vars, &$var, &$info) { $value = $vars->get($var->getVarName()); $linfo = Horde_Nls::getLocaleInfo(); $value = str_replace($linfo['mon_thousands_sep'], '', $value); $info = str_replace($linfo['mon_decimal_point'], '.', $value); } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Number")); } } class Horde_Form_Type_int extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value) && ((string)(int)$value !== $value)) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (empty($value) || preg_match('/^[0-9]+$/', $value)) { return true; } $message = Horde_Form_Translation::t("This field may only contain integers."); return false; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Integer")); } } class Horde_Form_Type_octal extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value) && ((string)(int)$value !== $value)) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (empty($value) || preg_match('/^[0-7]+$/', $value)) { return true; } $message = Horde_Form_Translation::t("This field may only contain octal values."); return false; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Octal")); } } class Horde_Form_Type_intlist extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if (empty($value) && $var->isRequired()) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (empty($value) || preg_match('/^[0-9 ,]+$/', $value)) { return true; } $message = Horde_Form_Translation::t("This field must be a comma or space separated list of integers"); return false; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Integer list")); } } class Horde_Form_Type_text extends Horde_Form_Type { var $_regex; var $_size; var $_maxlength; /** * The initialisation function for the text variable type. * * @access private * * @param string $regex Any valid PHP PCRE pattern syntax that * needs to be matched for the field to be * considered valid. If left empty validity * will be checked only for required fields * whether they are empty or not. * If using this regex test it is advisable * to enter a description for this field to * warn the user what is expected, as the * generated error message is quite generic * and will not give any indication where * the regex failed. * @param integer $size The size of the input field. * @param integer $maxlength The max number of characters. */ function init($regex = '', $size = 40, $maxlength = null) { $this->_regex = $regex; $this->_size = $size; $this->_maxlength = $maxlength; } function isValid(&$var, &$vars, $value, &$message) { $valid = true; if (!empty($this->_maxlength) && Horde_String::length($value) > $this->_maxlength) { $valid = false; $message = sprintf(Horde_Form_Translation::t("Value is over the maximum length of %d."), $this->_maxlength); } elseif ($var->isRequired() && empty($this->_regex)) { $valid = strlen(trim($value)) > 0; if (!$valid) { $message = Horde_Form_Translation::t("This field is required."); } } elseif (!empty($this->_regex)) { $valid = preg_match($this->_regex, $value); if (!$valid) { $message = Horde_Form_Translation::t("You must enter a valid value."); } } return $valid; } function getSize() { return $this->_size; } function getMaxLength() { return $this->_maxlength; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Text"), 'params' => array( 'regex' => array('label' => Horde_Form_Translation::t("Regex"), 'type' => 'text'), 'size' => array('label' => Horde_Form_Translation::t("Size"), 'type' => 'int'), 'maxlength' => array('label' => Horde_Form_Translation::t("Maximum length"), 'type' => 'int'))); } } class Horde_Form_Type_stringlist extends Horde_Form_Type_text { /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("String list"), 'params' => array( 'regex' => array('label' => Horde_Form_Translation::t("Regex"), 'type' => 'text'), 'size' => array('label' => Horde_Form_Translation::t("Size"), 'type' => 'int'), 'maxlength' => array('label' => Horde_Form_Translation::t("Maximum length"), 'type' => 'int')), ); } } class Horde_Form_Type_stringarray extends Horde_Form_Type_stringlist { function getInfo(&$vars, &$var, &$info) { $info = array_map('trim', explode(',', $vars->get($var->getVarName()))); } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("String list returning an array"), 'params' => array( 'regex' => array('label' => Horde_Form_Translation::t("Regex"), 'type' => 'text'), 'size' => array('label' => Horde_Form_Translation::t("Size"), 'type' => 'int'), 'maxlength' => array('label' => Horde_Form_Translation::t("Maximum length"), 'type' => 'int')), ); } } class Horde_Form_Type_phone extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if (!strlen(trim($value))) { if ($var->isRequired()) { $message = Horde_Form_Translation::t("This field is required."); return false; } } elseif (!preg_match('/^\+?[\d()\-\/. ]*$/', $value)) { $message = Horde_Form_Translation::t("You must enter a valid phone number, digits only with an optional '+' for the international dialing prefix."); return false; } return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Phone number")); } } class Horde_Form_Type_cellphone extends Horde_Form_Type_phone { /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Mobile phone number")); } } class Horde_Form_Type_ipaddress extends Horde_Form_Type_text { function isValid(&$var, &$vars, $value, &$message) { $valid = true; if (strlen(trim($value)) > 0) { $ip = explode('.', $value); $valid = (count($ip) == 4); if ($valid) { foreach ($ip as $part) { if (!is_numeric($part) || $part > 255 || $part < 0) { $valid = false; break; } } } if (!$valid) { $message = Horde_Form_Translation::t("Please enter a valid IP address."); } } elseif ($var->isRequired()) { $valid = false; $message = Horde_Form_Translation::t("This field is required."); } return $valid; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("IP address")); } } class Horde_Form_Type_ip6address extends Horde_Form_Type_text { function isValid(&$var, &$vars, $value, &$message) { $valid = true; if (strlen(trim($value)) > 0) { $valid = @inet_pton($value); if ($valid === false) { $message = Horde_Form_Translation::t("Please enter a valid IP address."); } } elseif ($var->isRequired()) { $valid = false; $message = Horde_Form_Translation::t("This field is required."); } return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("IPv6 address")); } } class Horde_Form_Type_longtext extends Horde_Form_Type_text { var $_rows; var $_cols; var $_helper = array(); function init($rows = 8, $cols = 80, $helper = array()) { if (!is_array($helper)) { $helper = array($helper); } $this->_rows = $rows; $this->_cols = $cols; $this->_helper = $helper; } function getRows() { return $this->_rows; } function getCols() { return $this->_cols; } function hasHelper($option = '') { if (empty($option)) { /* No option specified, check if any helpers have been * activated. */ return !empty($this->_helper); } elseif (empty($this->_helper)) { /* No helpers activated at all, return false. */ return false; } else { /* Check if given helper has been activated. */ return in_array($option, $this->_helper); } } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Long text"), 'params' => array( 'rows' => array('label' => Horde_Form_Translation::t("Number of rows"), 'type' => 'int'), 'cols' => array('label' => Horde_Form_Translation::t("Number of columns"), 'type' => 'int'), 'helper' => array('label' => Horde_Form_Translation::t("Helpers"), 'type' => 'stringarray'))); } } class Horde_Form_Type_countedtext extends Horde_Form_Type_longtext { var $_chars; function init($rows = null, $cols = null, $chars = 1000) { parent::init($rows, $cols); $this->_chars = $chars; } function isValid(&$var, &$vars, $value, &$message) { $valid = true; $length = Horde_String::length(trim($value)); if ($var->isRequired() && $length <= 0) { $valid = false; $message = Horde_Form_Translation::t("This field is required."); } elseif ($length > $this->_chars) { $valid = false; $message = sprintf(Horde_Form_Translation::ngettext("There are too many characters in this field. You have entered %d character; ", "There are too many characters in this field. You have entered %d characters; ", $length), $length) . sprintf(Horde_Form_Translation::t("you must enter less than %d."), $this->_chars); } return $valid; } function getChars() { return $this->_chars; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Counted text"), 'params' => array( 'rows' => array('label' => Horde_Form_Translation::t("Number of rows"), 'type' => 'int'), 'cols' => array('label' => Horde_Form_Translation::t("Number of columns"), 'type' => 'int'), 'chars' => array('label' => Horde_Form_Translation::t("Number of characters"), 'type' => 'int'))); } } class Horde_Form_Type_address extends Horde_Form_Type_longtext { function parse($address) { $info = array(); $aus_state_regex = '(?:ACT|NSW|NT|QLD|SA|TAS|VIC|WA)'; if (preg_match('/(?s)(.*?)(?-s)\r?\n(?:(.*?)\s+)?((?:A[BL]|B[ABDHLNRST]?|C[ABFHMORTVW]|D[ADEGHLNTY]|E[CHNX]?|F[KY]|G[LUY]?|H[ADGPRSUX]|I[GMPV]|JE|K[ATWY]|L[ADELNSU]?|M[EKL]?|N[EGNPRW]?|O[LX]|P[AEHLOR]|R[GHM]|S[AEGKLMNOPRSTWY]?|T[ADFNQRSW]|UB|W[ACDFNRSV]?|YO|ZE)\d(?:\d|[A-Z])? \d[A-Z]{2})/', $address, $addressParts)) { /* UK postcode detected. */ $info = array('country' => 'uk', 'zip' => $addressParts[3]); if (!empty($addressParts[1])) { $info['street'] = $addressParts[1]; } if (!empty($addressParts[2])) { $info['city'] = $addressParts[2]; } } elseif (preg_match('/\b' . $aus_state_regex . '\b/', $address)) { /* Australian state detected. */ /* Split out the address, line-by-line. */ $addressLines = preg_split('/\r?\n/', $address); $info = array('country' => 'au'); for ($i = 0; $i < count($addressLines); $i++) { /* See if it's the street number & name. */ if (preg_match('/(\d+\s*\/\s*)?(\d+|\d+[a-zA-Z])\s+([a-zA-Z ]*)/', $addressLines[$i], $lineParts)) { $info['street'] = $addressLines[$i]; $info['streetNumber'] = $lineParts[2]; $info['streetName'] = $lineParts[3]; } /* Look for "Suburb, State". */ if (preg_match('/([a-zA-Z ]*),?\s+(' . $aus_state_regex . ')/', $addressLines[$i], $lineParts)) { $info['city'] = $lineParts[1]; $info['state'] = $lineParts[2]; } /* Look for "State <4 digit postcode>". */ if (preg_match('/(' . $aus_state_regex . ')\s+(\d{4})/', $addressLines[$i], $lineParts)) { $info['state'] = $lineParts[1]; $info['zip'] = $lineParts[2]; } } } elseif (preg_match('/(?s)(.*?)(?-s)\r?\n(.*)\s*,\s*(\w+)\.?\s+(\d+|[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d)/', $address, $addressParts)) { /* American/Canadian address style. */ $info = array('country' => 'us'); if (!empty($addressParts[4]) && preg_match('|[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d|', $addressParts[4])) { $info['country'] = 'ca'; } if (!empty($addressParts[1])) { $info['street'] = $addressParts[1]; } if (!empty($addressParts[2])) { $info['city'] = $addressParts[2]; } if (!empty($addressParts[3])) { $info['state'] = $addressParts[3]; } if (!empty($addressParts[4])) { $info['zip'] = $addressParts[4]; } } elseif (preg_match('/(?:(?s)(.*?)(?-s)(?:\r?\n|,\s*))?(?:([A-Z]{1,3})-)?(\d{4,5})\s+(.*)(?:\r?\n(.*))?/i', $address, $addressParts)) { /* European address style. */ $info = array(); if (!empty($addressParts[1])) { $info['street'] = $addressParts[1]; } if (!empty($addressParts[2])) { include 'Horde/Nls/Carsigns.php'; $country = array_search(Horde_String::upper($addressParts[2]), $carsigns); if ($country) { $info['country'] = $country; } } if (!empty($addressParts[5])) { include 'Horde/Nls/Countries.php'; $country = array_search($addressParts[5], $countries); if ($country) { $info['country'] = Horde_String::lower($country); } elseif (!isset($info['street'])) { $info['street'] = trim($addressParts[5]); } else { $info['street'] .= "\n" . $addressParts[5]; } } if (!empty($addressParts[3])) { $info['zip'] = $addressParts[3]; } if (!empty($addressParts[4])) { $info['city'] = trim($addressParts[4]); } } return $info; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Address"), 'params' => array( 'rows' => array('label' => Horde_Form_Translation::t("Number of rows"), 'type' => 'int'), 'cols' => array('label' => Horde_Form_Translation::t("Number of columns"), 'type' => 'int'))); } } class Horde_Form_Type_addresslink extends Horde_Form_Type_address { function isValid(&$var, &$vars, $value, &$message) { return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Address Link")); } } class Horde_Form_Type_pgp extends Horde_Form_Type_longtext { /** * Path to the GnuPG binary. * * @var string */ var $_gpg; /** * A temporary directory. * * @var string */ var $_temp; function init($gpg, $temp_dir = null, $rows = null, $cols = null) { $this->_gpg = $gpg; $this->_temp = $temp_dir; parent::init($rows, $cols); } /** * Returns a parameter hash for the Horde_Crypt_pgp constructor. * * @return array A parameter hash. */ function getPGPParams() { return array('program' => $this->_gpg, 'temp' => $this->_temp); } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("PGP Key"), 'params' => array( 'gpg' => array('label' => Horde_Form_Translation::t("Path to the GnuPG binary"), 'type' => 'string'), 'temp_dir' => array('label' => Horde_Form_Translation::t("A temporary directory"), 'type' => 'string'), 'rows' => array('label' => Horde_Form_Translation::t("Number of rows"), 'type' => 'int'), 'cols' => array('label' => Horde_Form_Translation::t("Number of columns"), 'type' => 'int'))); } } class Horde_Form_Type_smime extends Horde_Form_Type_longtext { /** * A temporary directory. * * @var string */ var $_temp; function init($temp_dir = null, $rows = null, $cols = null) { $this->_temp = $temp_dir; parent::init($rows, $cols); } /** * Returns a parameter hash for the Horde_Crypt_smime constructor. * * @return array A parameter hash. */ function getSMIMEParams() { return array('temp' => $this->_temp); } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("S/MIME Key"), 'params' => array( 'temp_dir' => array('label' => Horde_Form_Translation::t("A temporary directory"), 'type' => 'string'), 'rows' => array('label' => Horde_Form_Translation::t("Number of rows"), 'type' => 'int'), 'cols' => array('label' => Horde_Form_Translation::t("Number of columns"), 'type' => 'int'))); } } class Horde_Form_Type_country extends Horde_Form_Type_enum { function init($prompt = null) { parent::init(Horde_Nls::getCountryISO(), $prompt); } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Country drop down list"), 'params' => array( 'prompt' => array('label' => Horde_Form_Translation::t("Prompt text"), 'type' => 'text'))); } } class Horde_Form_Type_file extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired()) { try { $GLOBALS['browser']->wasFileUploaded($var->getVarName()); } catch (Horde_Browser_Exception $e) { $message = $e->getMessage(); return false; } } return true; } function getInfo(&$vars, &$var, &$info) { $name = $var->getVarName(); try { $GLOBALS['browser']->wasFileUploaded($name); $info['name'] = Horde_Util::dispelMagicQuotes($_FILES[$name]['name']); $info['type'] = $_FILES[$name]['type']; $info['tmp_name'] = $_FILES[$name]['tmp_name']; $info['file'] = $_FILES[$name]['tmp_name']; $info['error'] = $_FILES[$name]['error']; $info['size'] = $_FILES[$name]['size']; } catch (Horde_Browser_Exception $e) {} } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("File upload")); } } class Horde_Form_Type_image extends Horde_Form_Type { /** * Has a file been uploaded on this form submit? * * @var boolean */ var $_uploaded = null; /** * Show the upload button? * * @var boolean */ var $_show_upload = true; /** * Show the option to upload also original non-modified image? * * @var boolean */ var $_show_keeporig = false; /** * Limit the file size? * * @var integer */ var $_max_filesize = null; /** * Hash containing the previously uploaded image info. * * @var array */ var $_img; /** * A random id that identifies the image information in the session data. * * @var string */ var $_random; function init($show_upload = true, $show_keeporig = false, $max_filesize = null) { $this->_show_upload = $show_upload; $this->_show_keeporig = $show_keeporig; $this->_max_filesize = $max_filesize; } function onSubmit(&$var, &$vars) { /* Are we removing an image? */ if ($vars->get('remove_' . $var->getVarName())) { $GLOBALS['session']->remove('horde', 'form/' . $this->getRandomId()); $this->_img = null; return; } /* Get the upload. */ $this->getImage($vars, $var); /* If this was done through the upload button override the submitted * value of the form. */ if ($vars->get('do_' . $var->getVarName())) { $var->form->setSubmitted(false); if ($this->_uploaded instanceof Horde_Browser_Exception) { $this->_img = array('hash' => $this->getRandomId(), 'error' => $this->_uploaded->getMessage()); } } } function isValid(&$var, &$vars, $value, &$message) { if ($vars->get('remove_' . $var->getVarName())) { return true; } /* Get the upload. */ $this->getImage($vars, $var); $field = $vars->get($var->getVarName()); /* The upload generated a PEAR Error. */ if ($this->_uploaded instanceof Horde_Browser_Exception) { /* Not required and no image upload attempted. */ if (!$var->isRequired() && empty($field['hash']) && $this->_uploaded->getCode() == UPLOAD_ERR_NO_FILE) { return true; } if (($this->_uploaded->getCode() == UPLOAD_ERR_NO_FILE) && empty($field['hash'])) { /* Nothing uploaded and no older upload. */ $message = Horde_Form_Translation::t("This field is required."); return false; } elseif (!empty($field['hash'])) { if ($this->_img && isset($this->_img['error'])) { $message = $this->_img['error']; return false; } /* Nothing uploaded but older upload present. */ return true; } else { /* Some other error message. */ $message = $this->_uploaded->getMessage(); return false; } } elseif (empty($this->_img['img']['size'])) { $message = Horde_Form_Translation::t("The image file size could not be determined or it was 0 bytes. The upload may have been interrupted."); return false; } elseif ($this->_max_filesize && $this->_img['img']['size'] > $this->_max_filesize) { $message = sprintf(Horde_Form_Translation::t("The image file was larger than the maximum allowed size (%d bytes)."), $this->_max_filesize); return false; } return true; } function getInfo(&$vars, &$var, &$info) { /* Get the upload. */ $this->getImage($vars, $var); /* Get image params stored in the hidden field. */ $value = $var->getValue($vars); $info = $this->_img['img']; if (empty($info['file'])) { unset($info['file']); return; } if ($this->_show_keeporig) { $info['keep_orig'] = !empty($value['keep_orig']); } /* Set the uploaded value (either true or Horde_Browser_Exception). */ $info['uploaded'] = &$this->_uploaded; /* If a modified file exists move it over the original. */ if ($this->_show_keeporig && $info['keep_orig']) { /* Requested the saving of original file also. */ $info['orig_file'] = Horde::getTempDir() . '/' . $info['file']; $info['file'] = Horde::getTempDir() . '/mod_' . $info['file']; /* Check if a modified file actually exists. */ if (!file_exists($info['file'])) { $info['file'] = $info['orig_file']; unset($info['orig_file']); } } else { /* Saving of original not required. */ $mod_file = Horde::getTempDir() . '/mod_' . $info['file']; $info['file'] = Horde::getTempDir() . '/' . $info['file']; if (file_exists($mod_file)) { /* Unlink first (has to be done on Windows machines?) */ unlink($info['file']); rename($mod_file, $info['file']); } } } /** * Gets the upload and sets up the upload data array. Either * fetches an upload done with this submit or retries stored * upload info. */ function _getUpload(&$vars, &$var) { global $session; /* Don't bother with this function if already called and set * up vars. */ if (!empty($this->_img)) { return true; } /* Check if file has been uploaded. */ $varname = $var->getVarName(); try { $GLOBALS['browser']->wasFileUploaded($varname . '[new]'); $this->_uploaded = true; /* A file has been uploaded on this submit. Save to temp dir for * preview work. */ $this->_img['img']['type'] = $this->getUploadedFileType($varname . '[new]'); /* Get the other parts of the upload. */ Horde_Array::getArrayParts($varname . '[new]', $base, $keys); /* Get the temporary file name. */ $keys_path = array_merge(array($base, 'tmp_name'), $keys); $this->_img['img']['file'] = Horde_Array::getElement($_FILES, $keys_path); /* Get the actual file name. */ $keys_path = array_merge(array($base, 'name'), $keys); $this->_img['img']['name'] = Horde_Array::getElement($_FILES, $keys_path); /* Get the file size. */ $keys_path = array_merge(array($base, 'size'), $keys); $this->_img['img']['size'] = Horde_Array::getElement($_FILES, $keys_path); /* Get any existing values for the image upload field. */ $upload = $vars->get($var->getVarName()); if (!empty($upload['hash'])) { $upload['img'] = $session->get('horde', 'form/' . $upload['hash']); $session->remove('horde', 'form/' . $upload['hash']); } /* Get the temp file if already one uploaded, otherwise create a * new temporary file. */ if (!empty($upload['img']['file'])) { $tmp_file = Horde::getTempDir() . '/' . $upload['img']['file']; } else { $tmp_file = Horde::getTempFile('Horde', false); } /* Move the browser created temp file to the new temp file. */ move_uploaded_file($this->_img['img']['file'], $tmp_file); $this->_img['img']['file'] = basename($tmp_file); } catch (Horde_Browser_Exception $e) { $this->_uploaded = $e; /* File has not been uploaded. */ $upload = $vars->get($var->getVarName()); /* File is explicitly removed */ if ($vars->get('remove_' . $var->getVarName())) { $this->_img = null; $session->remove('horde', 'form/' . $upload['hash']); return; } if ($this->_uploaded->getCode() == 4 && !empty($upload['hash']) && $session->exists('horde', 'form/' . $upload['hash'])) { $this->_img['img'] = $session->get('horde', 'form/' . $upload['hash']); $session->remove('horde', 'form/' . $upload['hash']); if (isset($this->_img['error'])) { $this->_uploaded = PEAR::raiseError($this->_img['error']); } } } if (isset($this->_img['img'])) { $session->set('horde', 'form/' . $this->getRandomId(), $this->_img['img']); } } function getUploadedFileType($field) { /* Get any index on the field name. */ $index = Horde_Array::getArrayParts($field, $base, $keys); if ($index) { /* Index present, fetch the mime type var to check. */ $keys_path = array_merge(array($base, 'type'), $keys); $type = Horde_Array::getElement($_FILES, $keys_path); $keys_path = array_merge(array($base, 'tmp_name'), $keys); $tmp_name = Horde_Array::getElement($_FILES, $keys_path); } else { /* No index, simple set up of vars to check. */ $type = $_FILES[$field]['type']; $tmp_name = $_FILES[$field]['tmp_name']; } if (empty($type) || ($type == 'application/octet-stream')) { /* Type wasn't set on upload, try analising the upload. */ if (!($type = Horde_Mime_Magic::analyzeFile($tmp_name, isset($GLOBALS['conf']['mime']['magic_db']) ? $GLOBALS['conf']['mime']['magic_db'] : null))) { if ($index) { /* Get the name value. */ $keys_path = array_merge(array($base, 'name'), $keys); $name = Horde_Array::getElement($_FILES, $keys_path); /* Work out the type from the file name. */ $type = Horde_Mime_Magic::filenameToMime($name); /* Set the type. */ $keys_path = array_merge(array($base, 'type'), $keys); Horde_Array::getElement($_FILES, $keys_path, $type); } else { /* Work out the type from the file name. */ $type = Horde_Mime_Magic::filenameToMime($_FILES[$field]['name']); /* Set the type. */ $_FILES[$field]['type'] = Horde_Mime_Magic::filenameToMime($_FILES[$field]['name']); } } } return $type; } /** * Returns the current image information. * * @return array The current image hash. */ function getImage($vars, $var) { $this->_getUpload($vars, $var); if (!isset($this->_img)) { $image = $vars->get($var->getVarName()); if ($image) { $this->loadImageData($image); if (isset($image['img'])) { $this->_img = $image; $GLOBALS['session']->set('horde', 'form/' . $this->getRandomId(), $this->_img['img']); } } } return $this->_img; } /** * Loads any existing image data into the image field. Requires that the * array $image passed to it contains the structure: * $image['load']['file'] - the filename of the image; * $image['load']['data'] - the raw image data. * * @param array $image The image array. */ function loadImageData(&$image) { /* No existing image data to load. */ if (!isset($image['load'])) { return; } /* Save the data to the temp dir. */ $tmp_file = Horde::getTempDir() . '/' . $image['load']['file']; if ($fd = fopen($tmp_file, 'w')) { fwrite($fd, $image['load']['data']); fclose($fd); } $image['img'] = array('file' => $image['load']['file']); unset($image['load']); } function getRandomId() { if (!isset($this->_random)) { $this->_random = uniqid(mt_rand()); } return $this->_random; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Image upload"), 'params' => array( 'show_upload' => array('label' => Horde_Form_Translation::t("Show upload?"), 'type' => 'boolean'), 'show_keeporig' => array('label' => Horde_Form_Translation::t("Show option to keep original?"), 'type' => 'boolean'), 'max_filesize' => array('label' => Horde_Form_Translation::t("Maximum file size in bytes"), 'type' => 'int'))); } } class Horde_Form_Type_boolean extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { return true; } function getInfo(&$vars, &$var, &$info) { $info = Horde_String::lower($vars->get($var->getVarName())) == 'on'; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("True or false")); } } class Horde_Form_Type_link extends Horde_Form_Type { /** * List of hashes containing link parameters. Possible keys: 'url', 'text', * 'target', 'onclick', 'title', 'accesskey'. * * @var array */ var $values; function init($values) { $this->values = $values; } function isValid(&$var, &$vars, $value, &$message) { return true; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Link"), 'params' => array( 'url' => array( 'label' => Horde_Form_Translation::t("Link URL"), 'type' => 'text'), 'text' => array( 'label' => Horde_Form_Translation::t("Link text"), 'type' => 'text'), 'target' => array( 'label' => Horde_Form_Translation::t("Link target"), 'type' => 'text'), 'onclick' => array( 'label' => Horde_Form_Translation::t("Onclick event"), 'type' => 'text'), 'title' => array( 'label' => Horde_Form_Translation::t("Link title attribute"), 'type' => 'text'), 'accesskey' => array( 'label' => Horde_Form_Translation::t("Link access key"), 'type' => 'text'))); } } class Horde_Form_Type_email extends Horde_Form_Type { /** * Allow multiple addresses? * * @var boolean */ var $_allow_multi = false; /** * Protect address from spammers? * * @var boolean */ var $_strip_domain = false; /** * Link the email address to the compose page when displaying? * * @var boolean */ var $_link_compose = false; /** * Whether to check the domain's SMTP server whether the address exists. * * @var boolean */ var $_check_smtp = false; /** * The name to use when linking to the compose page * * @var boolean */ var $_link_name; /** * A string containing valid delimiters (default is just comma). * * @var string */ var $_delimiters = ','; /** * @param boolean $allow_multi Allow multiple addresses? * @param boolean $strip_domain Protect address from spammers? * @param boolean $link_compose Link the email address to the compose page * when displaying? * @param string $link_name The name to use when linking to the * compose page. * @param string $delimiters Character to split multiple addresses with. */ function init($allow_multi = false, $strip_domain = false, $link_compose = false, $link_name = null, $delimiters = ',') { $this->_allow_multi = $allow_multi; $this->_strip_domain = $strip_domain; $this->_link_compose = $link_compose; $this->_link_name = $link_name; $this->_delimiters = $delimiters; } /** */ function isValid(&$var, &$vars, $value, &$message) { // Split into individual addresses. $emails = $this->splitEmailAddresses($value); // Check for too many. if (!$this->_allow_multi && count($emails) > 1) { $message = Horde_Form_Translation::t("Only one email address is allowed."); return false; } // Check for all valid and at least one non-empty. $nonEmpty = 0; foreach ($emails as $email) { if (!strlen($email)) { continue; } if (!$this->validateEmailAddress($email)) { $message = sprintf(Horde_Form_Translation::t("\"%s\" is not a valid email address."), htmlspecialchars($email)); return false; } ++$nonEmpty; } if (!$nonEmpty && $var->isRequired()) { if ($this->_allow_multi) { $message = Horde_Form_Translation::t("You must enter at least one email address."); } else { $message = Horde_Form_Translation::t("You must enter an email address."); } return false; } return true; } /** * Explodes an RFC 2822 string, ignoring a delimiter if preceded * by a "\" character, or if the delimiter is inside single or * double quotes. * * @param string $string The RFC 822 string. * * @return array The exploded string in an array. */ function splitEmailAddresses($string) { $quotes = array('"', "'"); $emails = array(); $pos = 0; $in_quote = null; $in_group = false; $prev = null; if (!strlen($string)) { return array(); } $char = $string[0]; if (in_array($char, $quotes)) { $in_quote = $char; } elseif ($char == ':') { $in_group = true; } elseif (strpos($this->_delimiters, $char) !== false) { $emails[] = ''; $pos = 1; } for ($i = 1, $iMax = strlen($string); $i < $iMax; ++$i) { $char = $string[$i]; if (in_array($char, $quotes)) { if ($prev !== '\\') { if ($in_quote === $char) { $in_quote = null; } elseif (is_null($in_quote)) { $in_quote = $char; } } } elseif ($in_group) { if ($char == ';') { $emails[] = substr($string, $pos, $i - $pos + 1); $pos = $i + 1; $in_group = false; } } elseif ($char == ':') { $in_group = true; } elseif (strpos($this->_delimiters, $char) !== false && $prev !== '\\' && is_null($in_quote)) { $emails[] = substr($string, $pos, $i - $pos); $pos = $i + 1; } $prev = $char; } if ($pos != $i) { /* The string ended without a delimiter. */ $emails[] = substr($string, $pos, $i - $pos); } return $emails; } /** * @param string $email An individual email address to validate. * * @return boolean */ function validateEmailAddress($email) { $result = $this->_isRfc3696ValidEmailAddress($email); if ($result && $this->_check_smtp) { $result = $this->validateEmailAddressSmtp($email); } return $result; } /** * Attempt partial delivery of mail to an address to validate it. * * @param string $email An individual email address to validate. * * @return boolean */ function validateEmailAddressSmtp($email) { list(, $maildomain) = explode('@', $email, 2); // Try to get the real mailserver from MX records. if (function_exists('getmxrr') && @getmxrr($maildomain, $mxhosts, $mxpriorities)) { // MX record found. array_multisort($mxpriorities, $mxhosts); $mailhost = $mxhosts[0]; } else { // No MX record found, try the root domain as the mail // server. $mailhost = $maildomain; } $fp = @fsockopen($mailhost, 25, $errno, $errstr, 5); if (!$fp) { return false; } // Read initial response. fgets($fp, 4096); // HELO fputs($fp, "HELO $mailhost\r\n"); fgets($fp, 4096); // MAIL FROM fputs($fp, "MAIL FROM: \r\n"); fgets($fp, 4096); // RCPT TO - gets the result we want. fputs($fp, "RCPT TO: <$email>\r\n"); $result = trim(fgets($fp, 4096)); // QUIT fputs($fp, "QUIT\r\n"); fgets($fp, 4096); fclose($fp); return substr($result, 0, 1) == '2'; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Email"), 'params' => array( 'allow_multi' => array( 'label' => Horde_Form_Translation::t("Allow multiple addresses?"), 'type' => 'boolean'), 'strip_domain' => array( 'label' => Horde_Form_Translation::t("Protect address from spammers?"), 'type' => 'boolean'), 'link_compose' => array( 'label' => Horde_Form_Translation::t("Link the email address to the compose page when displaying?"), 'type' => 'boolean'), 'link_name' => array( 'label' => Horde_Form_Translation::t("The name to use when linking to the compose page"), 'type' => 'text'), 'delimiters' => array( 'label' => Horde_Form_Translation::t("Character to split multiple addresses with"), 'type' => 'text'), ), ); } /** * RFC3696 Email Parser * * By Cal Henderson * * This code is dual licensed: * CC Attribution-ShareAlike 2.5 - http://creativecommons.org/licenses/by-sa/2.5/ * GPLv3 - http://www.gnu.org/copyleft/gpl.html */ protected function _isRfc3696ValidEmailAddress($email) { #################################################################################### # # NO-WS-CTL = %d1-8 / ; US-ASCII control characters # %d11 / ; that do not include the # %d12 / ; carriage return, line feed, # %d14-31 / ; and white space characters # %d127 # ALPHA = %x41-5A / %x61-7A ; A-Z / a-z # DIGIT = %x30-39 $no_ws_ctl = "[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x7f]"; $alpha = "[\\x41-\\x5a\\x61-\\x7a]"; $digit = "[\\x30-\\x39]"; $cr = "\\x0d"; $lf = "\\x0a"; $crlf = "(?:$cr$lf)"; #################################################################################### # # obs-char = %d0-9 / %d11 / ; %d0-127 except CR and # %d12 / %d14-127 ; LF # obs-text = *LF *CR *(obs-char *LF *CR) # text = %d1-9 / ; Characters excluding CR and LF # %d11 / # %d12 / # %d14-127 / # obs-text # obs-qp = "\" (%d0-127) # quoted-pair = ("\" text) / obs-qp $obs_char = "[\\x00-\\x09\\x0b\\x0c\\x0e-\\x7f]"; $obs_text = "(?:$lf*$cr*(?:$obs_char$lf*$cr*)*)"; $text = "(?:[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f]|$obs_text)"; # # there's an issue with the definition of 'text', since 'obs_text' can # be blank and that allows qp's with no character after the slash. we're # treating that as bad, so this just checks we have at least one # (non-CRLF) character # $text = "(?:$lf*$cr*$obs_char$lf*$cr*)"; $obs_qp = "(?:\\x5c[\\x00-\\x7f])"; $quoted_pair = "(?:\\x5c$text|$obs_qp)"; #################################################################################### # # obs-FWS = 1*WSP *(CRLF 1*WSP) # FWS = ([*WSP CRLF] 1*WSP) / ; Folding white space # obs-FWS # ctext = NO-WS-CTL / ; Non white space controls # %d33-39 / ; The rest of the US-ASCII # %d42-91 / ; characters not including "(", # %d93-126 ; ")", or "\" # ccontent = ctext / quoted-pair / comment # comment = "(" *([FWS] ccontent) [FWS] ")" # CFWS = *([FWS] comment) (([FWS] comment) / FWS) # # note: we translate ccontent only partially to avoid an infinite loop # instead, we'll recursively strip *nested* comments before processing # the input. that will leave 'plain old comments' to be matched during # the main parse. # $wsp = "[\\x20\\x09]"; $obs_fws = "(?:$wsp+(?:$crlf$wsp+)*)"; $fws = "(?:(?:(?:$wsp*$crlf)?$wsp+)|$obs_fws)"; $ctext = "(?:$no_ws_ctl|[\\x21-\\x27\\x2A-\\x5b\\x5d-\\x7e])"; $ccontent = "(?:$ctext|$quoted_pair)"; $comment = "(?:\\x28(?:$fws?$ccontent)*$fws?\\x29)"; $cfws = "(?:(?:$fws?$comment)*(?:$fws?$comment|$fws))"; # # these are the rules for removing *nested* comments. we'll just detect # outer comment and replace it with an empty comment, and recurse until # we stop. # $outer_ccontent_dull = "(?:$fws?$ctext|$quoted_pair)"; $outer_ccontent_nest = "(?:$fws?$comment)"; $outer_comment = "(?:\\x28$outer_ccontent_dull*(?:$outer_ccontent_nest$outer_ccontent_dull*)+$fws?\\x29)"; #################################################################################### # # atext = ALPHA / DIGIT / ; Any character except controls, # "!" / "#" / ; SP, and specials. # "$" / "%" / ; Used for atoms # "&" / "'" / # "*" / "+" / # "-" / "/" / # "=" / "?" / # "^" / "_" / # "`" / "{" / # "|" / "}" / # "~" # atom = [CFWS] 1*atext [CFWS] $atext = "(?:$alpha|$digit|[\\x21\\x23-\\x27\\x2a\\x2b\\x2d\\x2f\\x3d\\x3f\\x5e\\x5f\\x60\\x7b-\\x7e])"; $atom = "(?:$cfws?(?:$atext)+$cfws?)"; #################################################################################### # # qtext = NO-WS-CTL / ; Non white space controls # %d33 / ; The rest of the US-ASCII # %d35-91 / ; characters not including "\" # %d93-126 ; or the quote character # qcontent = qtext / quoted-pair # quoted-string = [CFWS] # DQUOTE *([FWS] qcontent) [FWS] DQUOTE # [CFWS] # word = atom / quoted-string $qtext = "(?:$no_ws_ctl|[\\x21\\x23-\\x5b\\x5d-\\x7e])"; $qcontent = "(?:$qtext|$quoted_pair)"; $quoted_string = "(?:$cfws?\\x22(?:$fws?$qcontent)*$fws?\\x22$cfws?)"; # # changed the '*' to a '+' to require that quoted strings are not empty # $quoted_string = "(?:$cfws?\\x22(?:$fws?$qcontent)+$fws?\\x22$cfws?)"; $word = "(?:$atom|$quoted_string)"; #################################################################################### # # obs-local-part = word *("." word) # obs-domain = atom *("." atom) $obs_local_part = "(?:$word(?:\\x2e$word)*)"; $obs_domain = "(?:$atom(?:\\x2e$atom)*)"; #################################################################################### # # dot-atom-text = 1*atext *("." 1*atext) # dot-atom = [CFWS] dot-atom-text [CFWS] $dot_atom_text = "(?:$atext+(?:\\x2e$atext+)*)"; $dot_atom = "(?:$cfws?$dot_atom_text$cfws?)"; #################################################################################### # # domain-literal = [CFWS] "[" *([FWS] dcontent) [FWS] "]" [CFWS] # dcontent = dtext / quoted-pair # dtext = NO-WS-CTL / ; Non white space controls # # %d33-90 / ; The rest of the US-ASCII # %d94-126 ; characters not including "[", # ; "]", or "\" $dtext = "(?:$no_ws_ctl|[\\x21-\\x5a\\x5e-\\x7e])"; $dcontent = "(?:$dtext|$quoted_pair)"; $domain_literal = "(?:$cfws?\\x5b(?:$fws?$dcontent)*$fws?\\x5d$cfws?)"; #################################################################################### # # local-part = dot-atom / quoted-string / obs-local-part # domain = dot-atom / domain-literal / obs-domain # addr-spec = local-part "@" domain $local_part = "(($dot_atom)|($quoted_string)|($obs_local_part))"; $domain = "(($dot_atom)|($domain_literal)|($obs_domain))"; $addr_spec = "$local_part\\x40$domain"; # # see http://www.dominicsayers.com/isemail/ for details, but this should probably be 254 # if (strlen($email) > 256) return 0; # # we need to strip nested comments first - we replace them with a simple comment # $email = $this->_rfc3696StripComments($outer_comment, $email, "(x)"); # # now match what's left # if (!preg_match("!^$addr_spec$!", $email, $m)){ return 0; } $bits = array( 'local' => isset($m[1]) ? $m[1] : '', 'local-atom' => isset($m[2]) ? $m[2] : '', 'local-quoted' => isset($m[3]) ? $m[3] : '', 'local-obs' => isset($m[4]) ? $m[4] : '', 'domain' => isset($m[5]) ? $m[5] : '', 'domain-atom' => isset($m[6]) ? $m[6] : '', 'domain-literal' => isset($m[7]) ? $m[7] : '', 'domain-obs' => isset($m[8]) ? $m[8] : '', ); # # we need to now strip comments from $bits[local] and $bits[domain], # since we know they're i the right place and we want them out of the # way for checking IPs, label sizes, etc # $bits['local'] = $this->_rfc3696StripComments($comment, $bits['local']); $bits['domain'] = $this->_rfc3696StripComments($comment, $bits['domain']); # # length limits on segments # if (strlen($bits['local']) > 64) return 0; if (strlen($bits['domain']) > 255) return 0; # # restrictuions on domain-literals from RFC2821 section 4.1.3 # if (strlen($bits['domain-literal'])){ $Snum = "(\d{1,3})"; $IPv4_address_literal = "$Snum\.$Snum\.$Snum\.$Snum"; $IPv6_hex = "(?:[0-9a-fA-F]{1,4})"; $IPv6_full = "IPv6\:$IPv6_hex(:?\:$IPv6_hex){7}"; $IPv6_comp_part = "(?:$IPv6_hex(?:\:$IPv6_hex){0,5})?"; $IPv6_comp = "IPv6\:($IPv6_comp_part\:\:$IPv6_comp_part)"; $IPv6v4_full = "IPv6\:$IPv6_hex(?:\:$IPv6_hex){5}\:$IPv4_address_literal"; $IPv6v4_comp_part = "$IPv6_hex(?:\:$IPv6_hex){0,3}"; $IPv6v4_comp = "IPv6\:((?:$IPv6v4_comp_part)?\:\:(?:$IPv6v4_comp_part\:)?)$IPv4_address_literal"; # # IPv4 is simple # if (preg_match("!^\[$IPv4_address_literal\]$!", $bits['domain'], $m)) { if (intval($m[1]) > 255) return 0; if (intval($m[2]) > 255) return 0; if (intval($m[3]) > 255) return 0; if (intval($m[4]) > 255) return 0; } else { # # this should be IPv6 - a bunch of tests are needed here :) # while (1) { if (preg_match("!^\[$IPv6_full\]$!", $bits['domain'])){ break; } if (preg_match("!^\[$IPv6_comp\]$!", $bits['domain'], $m)){ list($a, $b) = explode('::', $m[1]); $folded = (strlen($a) && strlen($b)) ? "$a:$b" : "$a$b"; $groups = explode(':', $folded); if (count($groups) > 6) return 0; break; } if (preg_match("!^\[$IPv6v4_full\]$!", $bits['domain'], $m)) { if (intval($m[1]) > 255) return 0; if (intval($m[2]) > 255) return 0; if (intval($m[3]) > 255) return 0; if (intval($m[4]) > 255) return 0; break; } if (preg_match("!^\[$IPv6v4_comp\]$!", $bits['domain'], $m)) { list($a, $b) = explode('::', $m[1]); $b = substr($b, 0, -1); # remove the trailing colon before the IPv4 address $folded = (strlen($a) && strlen($b)) ? "$a:$b" : "$a$b"; $groups = explode(':', $folded); if (count($groups) > 4) return 0; break; } return 0; } } } else { # # the domain is either dot-atom or obs-domain - either way, it's # made up of simple labels and we split on dots # $labels = explode('.', $bits['domain']); # # this is allowed by both dot-atom and obs-domain, but is un-routeable on the # public internet, so we'll fail it (e.g. user@localhost) # if (count($labels) == 1) return 0; # # checks on each label # foreach ($labels as $label) { if (strlen($label) > 63) return 0; if (substr($label, 0, 1) == '-') return 0; if (substr($label, -1) == '-') return 0; } # # last label can't be all numeric # if (preg_match('!^[0-9]+$!', array_pop($labels))) return 0; } return 1; } /** * RFC3696 Email Parser * * By Cal Henderson * * This code is dual licensed: * CC Attribution-ShareAlike 2.5 - http://creativecommons.org/licenses/by-sa/2.5/ * GPLv3 - http://www.gnu.org/copyleft/gpl.html * * $Revision: 5039 $ */ protected function _rfc3696StripComments($comment, $email, $replace = '') { while (1) { $new = preg_replace("!$comment!", $replace, $email); if (strlen($new) == strlen($email)) { return $email; } $email = $new; } } } class Horde_Form_Type_matrix extends Horde_Form_Type { var $_cols; var $_rows; var $_matrix; var $_new_input; /** * Initializes the variable. * * Example: * * init(array('Column A', 'Column B'), * array(1 => 'Row One', 2 => 'Row 2', 3 => 'Row 3'), * array(array(true, true, false), * array(true, false, true), * array(fasle, true, false)), * array('Row 4', 'Row 5')); * * * @param array $cols A list of column headers. * @param array $rows A hash with row IDs as the keys and row * labels as the values. * @param array $matrix A two dimensional hash with the field * values. * @param boolean|array $new_input If true, a free text field to add a new * row is displayed on the top, a select * box if this parameter is a value. */ function init($cols, $rows = array(), $matrix = array(), $new_input = false) { $this->_cols = $cols; $this->_rows = $rows; $this->_matrix = $matrix; $this->_new_input = $new_input; } function isValid(&$var, &$vars, $value, &$message) { return true; } function getCols() { return $this->_cols; } function getRows() { return $this->_rows; } function getMatrix() { return $this->_matrix; } function getNewInput() { return $this->_new_input; } function getInfo(&$vars, &$var, &$info) { $values = $vars->get($var->getVarName()); if (!empty($values['n']['r']) && isset($values['n']['v'])) { $new_row = $values['n']['r']; $values['r'][$new_row] = $values['n']['v']; unset($values['n']); } $info = (isset($values['r']) ? $values['r'] : array()); } function about() { return array( 'name' => Horde_Form_Translation::t("Field matrix"), 'params' => array( 'cols' => array('label' => Horde_Form_Translation::t("Column titles"), 'type' => 'stringarray'))); } } class Horde_Form_Type_emailConfirm extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value['original'])) { $message = Horde_Form_Translation::t("This field is required."); return false; } if ($value['original'] != $value['confirm']) { $message = Horde_Form_Translation::t("Email addresses must match."); return false; } else { try { $parsed_email = Horde_Mime_Address::parseAddressList($value['original'], array('validate' => true)); } catch (Horde_Mime_Exception $e) { $message = $e->getMessage(); return false; } if (count($parsed_email) > 1) { $message = Horde_Form_Translation::t("Only one email address allowed."); return false; } if (empty($parsed_email[0]->mailbox)) { $message = Horde_Form_Translation::t("You did not enter a valid email address."); return false; } } return true; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Email with confirmation")); } } class Horde_Form_Type_password extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { $valid = true; if ($var->isRequired()) { $valid = strlen(trim($value)) > 0; if (!$valid) { $message = Horde_Form_Translation::t("This field is required."); } } return $valid; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Password")); } } class Horde_Form_Type_passwordconfirm extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value['original'])) { $message = Horde_Form_Translation::t("This field is required."); return false; } if ($value['original'] != $value['confirm']) { $message = Horde_Form_Translation::t("Passwords must match."); return false; } return true; } function getInfo(&$vars, &$var, &$info) { $value = $vars->get($var->getVarName()); $info = $value['original']; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Password with confirmation")); } } class Horde_Form_Type_enum extends Horde_Form_Type { var $_values; var $_prompt; function init($values, $prompt = null) { $this->setValues($values); if ($prompt === true) { $this->_prompt = Horde_Form_Translation::t("-- select --"); } else { $this->_prompt = $prompt; } } function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && $value == '' && !isset($this->_values[$value])) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (count($this->_values) == 0 || isset($this->_values[$value]) || ($this->_prompt && empty($value))) { return true; } $message = Horde_Form_Translation::t("Invalid data submitted."); return false; } function getValues() { return $this->_values; } function setValues($values) { $this->_values = $values; } function getPrompt() { return $this->_prompt; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Drop down list"), 'params' => array( 'values' => array('label' => Horde_Form_Translation::t("Values to select from"), 'type' => 'stringarray'), 'prompt' => array('label' => Horde_Form_Translation::t("Prompt text"), 'type' => 'text'))); } } class Horde_Form_Type_mlenum extends Horde_Form_Type { var $_values; var $_prompts; function init(&$values, $prompts = null) { $this->_values = &$values; if ($prompts === true) { $this->_prompts = array(Horde_Form_Translation::t("-- select --"), Horde_Form_Translation::t("-- select --")); } elseif (!is_array($prompts)) { $this->_prompts = array($prompts, $prompts); } else { $this->_prompts = $prompts; } } function onSubmit(&$var, &$vars) { $varname = $var->getVarName(); $value = $vars->get($varname); if ($value['1'] != $value['old']) { $var->form->setSubmitted(false); } } function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && (empty($value['1']) || empty($value['2']))) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (!count($this->_values) || isset($this->_values[$value['1']]) || (!empty($this->_prompts) && empty($value['1']))) { return true; } $message = Horde_Form_Translation::t("Invalid data submitted."); return false; } function getValues() { return $this->_values; } function getPrompts() { return $this->_prompts; } function getInfo(&$vars, &$var, &$info) { $info = $vars->get($var->getVarName()); return $info['2']; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Multi-level drop down lists"), 'params' => array( 'values' => array('label' => Horde_Form_Translation::t("Values to select from"), 'type' => 'stringarray'), 'prompt' => array('label' => Horde_Form_Translation::t("Prompt text"), 'type' => 'text'))); } } class Horde_Form_Type_multienum extends Horde_Form_Type_enum { var $size = 5; function init($values, $size = null) { if (!is_null($size)) { $this->size = (int)$size; } parent::init($values); } function isValid(&$var, &$vars, $value, &$message) { if (is_array($value)) { foreach ($value as $val) { if (!$this->isValid($var, $vars, $val, $message)) { return false; } } return true; } if (empty($value) && ((string)(int)$value !== $value)) { if ($var->isRequired()) { $message = Horde_Form_Translation::t("This field is required."); return false; } else { return true; } } if (count($this->_values) == 0 || isset($this->_values[$value])) { return true; } $message = Horde_Form_Translation::t("Invalid data submitted."); return false; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Multiple selection"), 'params' => array( 'values' => array('label' => Horde_Form_Translation::t("Values"), 'type' => 'stringarray'), 'size' => array('label' => Horde_Form_Translation::t("Size"), 'type' => 'int')) ); } } class Horde_Form_Type_keyval_multienum extends Horde_Form_Type_multienum { function getInfo(&$vars, &$var, &$info) { $value = $vars->get($var->getVarName()); $info = array(); foreach ($value as $key) { $info[$key] = $this->_values[$key]; } } /** * Return info about field type. */ function about() { $about = parent::about(); $about['name'] = Horde_Form_Translation::t("Multiple selection, preserving keys"); } } class Horde_Form_Type_radio extends Horde_Form_Type_enum { /* Entirely implemented by Horde_Form_Type_enum; just a different * view. */ /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Radio selection"), 'params' => array( 'values' => array('label' => Horde_Form_Translation::t("Values"), 'type' => 'stringarray'))); } } class Horde_Form_Type_set extends Horde_Form_Type { var $_values; var $_checkAll = false; function init($values, $checkAll = false) { $this->_values = $values; $this->_checkAll = $checkAll; } function isValid(&$var, &$vars, $value, &$message) { if (count($this->_values) == 0 || count($value) == 0) { return true; } foreach ($value as $item) { if (!isset($this->_values[$item])) { $error = true; break; } } if (!isset($error)) { return true; } $message = Horde_Form_Translation::t("Invalid data submitted."); return false; } function getValues() { return $this->_values; } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Set"), 'params' => array( 'values' => array('label' => Horde_Form_Translation::t("Values"), 'type' => 'stringarray'))); } } class Horde_Form_Type_date extends Horde_Form_Type { var $_format; function init($format = '%a %d %B') { $this->_format = $format; } function isValid(&$var, &$vars, $value, &$message) { $valid = true; if ($var->isRequired()) { $valid = strlen(trim($value)) > 0; if (!$valid) { $message = sprintf(Horde_Form_Translation::t("%s is required"), $var->getHumanName()); } } return $valid; } /** * @static * * @param mixed $date The date to calculate the difference from. Can be * either a timestamp integer value, or an array * with date parts: 'day', 'month', 'year'. * * @return string */ function getAgo($date) { if ($date === null) { return ''; } try { $today = new Horde_Date(time()); $date = new Horde_Date($date); $ago = $date->toDays() - $today->toDays(); } catch (Horde_Date_Exception $e) { return ''; } if ($ago < -1) { return sprintf(Horde_Form_Translation::t(" (%s days ago)"), abs($ago)); } elseif ($ago == -1) { return Horde_Form_Translation::t(" (yesterday)"); } elseif ($ago == 0) { return Horde_Form_Translation::t(" (today)"); } elseif ($ago == 1) { return Horde_Form_Translation::t(" (tomorrow)"); } else { return sprintf(Horde_Form_Translation::t(" (in %s days)"), $ago); } } function getFormattedTime($timestamp, $format = null, $showago = true) { if (empty($format)) { $format = $this->_format; } if (!empty($timestamp)) { return strftime($format, $timestamp) . ($showago ? Horde_Form_Type_date::getAgo($timestamp) : ''); } else { return ''; } } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Date")); } } class Horde_Form_Type_time extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value) && ((string)(double)$value !== $value)) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (empty($value) || preg_match('/^[0-2]?[0-9]:[0-5][0-9]$/', $value)) { return true; } $message = Horde_Form_Translation::t("This field may only contain numbers and the colon."); return false; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Time")); } } class Horde_Form_Type_hourminutesecond extends Horde_Form_Type { var $_show_seconds; function init($show_seconds = false) { $this->_show_seconds = $show_seconds; } function isValid(&$var, &$vars, $value, &$message) { $time = $vars->get($var->getVarName()); if (!$this->_show_seconds && count($time) && !isset($time['second'])) { $time['second'] = 0; } if (!$this->emptyTimeArray($time) && !$this->checktime($time['hour'], $time['minute'], $time['second'])) { $message = Horde_Form_Translation::t("Please enter a valid time."); return false; } elseif ($this->emptyTimeArray($time) && $var->isRequired()) { $message = Horde_Form_Translation::t("This field is required."); return false; } return true; } function checktime($hour, $minute, $second) { if (!isset($hour) || $hour == '' || ($hour < 0 || $hour > 23)) { return false; } if (!isset($minute) || $minute == '' || ($minute < 0 || $minute > 60)) { return false; } if (!isset($second) || $second === '' || ($second < 0 || $second > 60)) { return false; } return true; } /** * Return the time supplied as a Horde_Date object. * * @param string $time_in Date in one of the three formats supported by * Horde_Form and Horde_Date (ISO format * YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS and * UNIX epoch). * * @return Horde_Date The time object. */ function getTimeOb($time_in) { if (is_array($time_in)) { if (!$this->emptyTimeArray($time_in)) { $time_in = sprintf('1970-01-01 %02d:%02d:%02d', $time_in['hour'], $time_in['minute'], $this->_show_seconds ? $time_in['second'] : 0); } } return new Horde_Date($time_in); } /** * Return the time supplied split up into an array. * * @param string $time_in Time in one of the three formats supported by * Horde_Form and Horde_Date (ISO format * YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS and * UNIX epoch). * * @return array Array with three elements - hour, minute and seconds. */ function getTimeParts($time_in) { if (is_array($time_in)) { /* This is probably a failed isValid input so just return the * parts as they are. */ return $time_in; } elseif (empty($time_in)) { /* This is just an empty field so return empty parts. */ return array('hour' => '', 'minute' => '', 'second' => ''); } $time = $this->getTimeOb($time_in); return array('hour' => $time->hour, 'minute' => $time->min, 'second' => $time->sec); } function emptyTimeArray($time) { return (is_array($time) && (!isset($time['hour']) || !strlen($time['hour'])) && (!isset($time['minute']) || !strlen($time['minute'])) && (!$this->_show_seconds || !strlen($time['second']))); } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Time selection"), 'params' => array( 'seconds' => array('label' => Horde_Form_Translation::t("Show seconds?"), 'type' => 'boolean'))); } } class Horde_Form_Type_monthyear extends Horde_Form_Type { var $_start_year; var $_end_year; function init($start_year = null, $end_year = null) { if (empty($start_year)) { $start_year = 1920; } if (empty($end_year)) { $end_year = date('Y'); } $this->_start_year = $start_year; $this->_end_year = $end_year; } function isValid(&$var, &$vars, $value, &$message) { if (!$var->isRequired()) { return true; } if (!$vars->get($this->getMonthVar($var)) || !$vars->get($this->getYearVar($var))) { $message = Horde_Form_Translation::t("Please enter a month and a year."); return false; } return true; } function getMonthVar($var) { return $var->getVarName() . '[month]'; } function getYearVar($var) { return $var->getVarName() . '[year]'; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Month and year"), 'params' => array( 'start_year' => array('label' => Horde_Form_Translation::t("Start year"), 'type' => 'int'), 'end_year' => array('label' => Horde_Form_Translation::t("End year"), 'type' => 'int'))); } } class Horde_Form_Type_monthdayyear extends Horde_Form_Type { var $_start_year; var $_end_year; var $_picker; var $_format_in = null; var $_format_out = '%x'; /** * Return the date supplied as a Horde_Date object. * * @param integer $start_year The first available year for input. * @param integer $end_year The last available year for input. * @param boolean $picker Do we show the DHTML calendar? * @param integer $format_in The format to use when sending the date * for storage. Defaults to Unix epoch. * Similar to the strftime() function. * @param integer $format_out The format to use when displaying the * date. Similar to the strftime() function. */ function init($start_year = '', $end_year = '', $picker = true, $format_in = null, $format_out = '%x') { if (empty($start_year)) { $start_year = date('Y'); } if (empty($end_year)) { $end_year = date('Y') + 10; } $this->_start_year = $start_year; $this->_end_year = $end_year; $this->_picker = $picker; $this->_format_in = $format_in; $this->_format_out = $format_out; } function isValid(&$var, &$vars, $value, &$message) { $date = $vars->get($var->getVarName()); $empty = $this->emptyDateArray($date); if ($empty == 1 && $var->isRequired()) { $message = Horde_Form_Translation::t("This field is required."); return false; } elseif ($empty == 0 && !checkdate($date['month'], $date['day'], $date['year'])) { $message = Horde_Form_Translation::t("Please enter a valid date, check the number of days in the month."); return false; } elseif ($empty == -1) { $message = Horde_Form_Translation::t("Select all date components."); return false; } return true; } /** * Determine if the provided date value is completely empty, partially empty * or non-empty. * * @param mixed $date String or date part array representation of date. * * @return integer 0 for non-empty, 1 for completely empty or -1 for * partially empty. */ function emptyDateArray($date) { if (!is_array($date)) { return (int)empty($date); } $empty = 0; /* Check each date array component. */ foreach (array('day', 'month', 'year') as $key) { if (empty($date[$key])) { $empty++; } } /* Check state of empty. */ if ($empty == 0) { /* If no empty parts return 0. */ return 0; } elseif ($empty == 3) { /* If all empty parts return 1. */ return 1; } else { /* If some empty parts return -1. */ return -1; } } /** * Return the date supplied split up into an array. * * @param string $date_in Date in one of the three formats supported by * Horde_Form and Horde_Date (ISO format * YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS * and UNIX epoch) plus the fourth YYYY-MM-DD. * * @return array Array with three elements - year, month and day. */ function getDateParts($date_in) { if (is_array($date_in)) { /* This is probably a failed isValid input so just return * the parts as they are. */ return $date_in; } elseif (empty($date_in)) { /* This is just an empty field so return empty parts. */ return array('year' => '', 'month' => '', 'day' => ''); } $date = $this->getDateOb($date_in); return array('year' => $date->year, 'month' => $date->month, 'day' => $date->mday); } /** * Return the date supplied as a Horde_Date object. * * @param string $date_in Date in one of the three formats supported by * Horde_Form and Horde_Date (ISO format * YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS * and UNIX epoch) plus the fourth YYYY-MM-DD. * * @return Horde_Date The date object. */ function getDateOb($date_in) { if (is_array($date_in)) { /* If passed an array change it to the ISO format. */ if ($this->emptyDateArray($date_in) == 0) { $date_in = sprintf('%04d-%02d-%02d 00:00:00', $date_in['year'], $date_in['month'], $date_in['day']); } } elseif (preg_match('/^\d{4}-?\d{2}-?\d{2}$/', $date_in)) { /* Fix the date if it is the shortened ISO. */ $date_in = $date_in . ' 00:00:00'; } return new Horde_Date($date_in); } /** * Return the date supplied as a Horde_Date object. * * @param string $date Either an already set up Horde_Date object or a * string date in one of the three formats supported * by Horde_Form and Horde_Date (ISO format * YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS and * UNIX epoch) plus the fourth YYYY-MM-DD. * * @return string The date formatted according to the $format_out * parameter when setting up the monthdayyear field. */ function formatDate($date) { if (!($date instanceof Horde_Date)) { $date = $this->getDateOb($date); } return $date->strftime($this->_format_out); } /** * Insert the date input through the form into $info array, in the format * specified by the $format_in parameter when setting up monthdayyear * field. */ function getInfo(&$vars, &$var, &$info) { $info = $this->_validateAndFormat($var->getValue($vars), $var); } /** * Validate/format a date submission. */ function _validateAndFormat($value, &$var) { /* If any component is empty consider it a bad date and return the * default. */ if ($this->emptyDateArray($value) == 1) { return $var->getDefault(); } else { $date = $this->getDateOb($value); if ($this->_format_in === null) { return $date->timestamp(); } else { return $date->strftime($this->_format_in); } } } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Date selection"), 'params' => array( 'start_year' => array('label' => Horde_Form_Translation::t("Start year"), 'type' => 'int'), 'end_year' => array('label' => Horde_Form_Translation::t("End year"), 'type' => 'int'), 'picker' => array('label' => Horde_Form_Translation::t("Show picker?"), 'type' => 'boolean'), 'format_in' => array('label' => Horde_Form_Translation::t("Storage format"), 'type' => 'text'), 'format_out' => array('label' => Horde_Form_Translation::t("Display format"), 'type' => 'text'))); } } class Horde_Form_Type_datetime extends Horde_Form_Type { var $_mdy; var $_hms; var $_show_seconds; /** * Return the date supplied as a Horde_Date object. * * @param integer $start_year The first available year for input. * @param integer $end_year The last available year for input. * @param boolean $picker Do we show the DHTML calendar? * @param integer $format_in The format to use when sending the date * for storage. Defaults to Unix epoch. * Similar to the strftime() function. * @param integer $format_out The format to use when displaying the * date. Similar to the strftime() function. * @param boolean $show_seconds Include a form input for seconds. */ function init($start_year = '', $end_year = '', $picker = true, $format_in = null, $format_out = '%x', $show_seconds = false) { $this->_mdy = new Horde_Form_Type_monthdayyear(); $this->_mdy->init($start_year, $end_year, $picker, $format_in, $format_out); $this->_hms = new Horde_Form_Type_hourminutesecond(); $this->_hms->init($show_seconds); $this->_show_seconds = $show_seconds; } function isValid(&$var, &$vars, $value, &$message) { $date = $vars->get($var->getVarName()); if (!$this->_show_seconds && !isset($date['second'])) { $date['second'] = ''; } $mdy_empty = $this->emptyDateArray($date); $hms_empty = $this->emptyTimeArray($date); $valid = true; /* Require all fields if one field is not empty */ if ($var->isRequired() || $mdy_empty != 1 || !$hms_empty) { $old_required = $var->required; $var->required = true; $mdy_valid = $this->_mdy->isValid($var, $vars, $value, $message); $hms_valid = $this->_hms->isValid($var, $vars, $value, $message); $var->required = $old_required; $valid = $mdy_valid && $hms_valid; if ($mdy_valid && !$hms_valid) { $message = Horde_Form_Translation::t("You must choose a time."); } elseif ($hms_valid && !$mdy_valid) { $message = Horde_Form_Translation::t("You must choose a date."); } } return $valid; } function getInfo(&$vars, &$var, &$info) { /* If any component is empty consider it a bad date and return the * default. */ $value = $var->getValue($vars); if ($this->emptyDateArray($value) == 1 || $this->emptyTimeArray($value)) { $info = $var->getDefault(); return; } $date = $this->getDateOb($value); $time = $this->getTimeOb($value); $date->hour = $time->hour; $date->min = $time->min; $date->sec = $time->sec; if ($this->getProperty('format_in') === null) { $info = $date->timestamp(); } else { $info = $date->strftime($this->getProperty('format_in')); } } function getProperty($property) { if ($property == 'show_seconds') { return $this->_hms->getProperty($property); } else { return $this->_mdy->getProperty($property); } } function setProperty($property, $value) { if ($property == 'show_seconds') { $this->_hms->setProperty($property, $value); } else { $this->_mdy->setProperty($property, $value); } } function checktime($hour, $minute, $second) { return $this->_hms->checktime($hour, $minute, $second); } function getTimeOb($time_in) { return $this->_hms->getTimeOb($time_in); } function getTimeParts($time_in) { return $this->_hms->getTimeParts($time_in); } function emptyTimeArray($time) { return $this->_hms->emptyTimeArray($time); } function emptyDateArray($date) { return $this->_mdy->emptyDateArray($date); } function getDateParts($date_in) { return $this->_mdy->getDateParts($date_in); } function getDateOb($date_in) { return $this->_mdy->getDateOb($date_in); } function formatDate($date) { if ($this->_mdy->emptyDateArray($date)) { return ''; } return $this->_mdy->formatDate($date); } function about() { return array( 'name' => Horde_Form_Translation::t("Date and time selection"), 'params' => array( 'start_year' => array('label' => Horde_Form_Translation::t("Start year"), 'type' => 'int'), 'end_year' => array('label' => Horde_Form_Translation::t("End year"), 'type' => 'int'), 'picker' => array('label' => Horde_Form_Translation::t("Show picker?"), 'type' => 'boolean'), 'format_in' => array('label' => Horde_Form_Translation::t("Storage format"), 'type' => 'text'), 'format_out' => array('label' => Horde_Form_Translation::t("Display format"), 'type' => 'text'), 'seconds' => array('label' => Horde_Form_Translation::t("Show seconds?"), 'type' => 'boolean'))); } } class Horde_Form_Type_colorpicker extends Horde_Form_Type { function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value)) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (empty($value) || preg_match('/^#([0-9a-z]){6}$/i', $value)) { return true; } $message = Horde_Form_Translation::t("This field must contain a color code in the RGB Hex format, for example '#1234af'."); return false; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Colour selection")); } } class Horde_Form_Type_sound extends Horde_Form_Type { var $_sounds = array(); function init() { $this->_sounds = array_keys(Horde_Themes::soundList()); } function getSounds() { return $this->_sounds; } function isValid(&$var, &$vars, $value, &$message) { if ($var->isRequired() && empty($value)) { $message = Horde_Form_Translation::t("This field is required."); return false; } if (empty($value) || in_array($value, $this->_sounds)) { return true; } $message = Horde_Form_Translation::t("Please choose a sound."); return false; } /** * Return info about field type. */ function about() { return array('name' => Horde_Form_Translation::t("Sound selection")); } } class Horde_Form_Type_sorter extends Horde_Form_Type { var $_instance; var $_values; var $_size; var $_header; function init($values, $size = 8, $header = '') { static $horde_sorter_instance = 0; /* Get the next progressive instance count for the horde * sorter so that multiple sorters can be used on one page. */ $horde_sorter_instance++; $this->_instance = 'horde_sorter_' . $horde_sorter_instance; $this->_values = $values; $this->_size = $size; $this->_header = $header; } function isValid(&$var, &$vars, $value, &$message) { return true; } function getValues() { return $this->_values; } function getSize() { return $this->_size; } function getHeader() { if (!empty($this->_header)) { return $this->_header; } return ''; } function getOptions($keys = null) { $html = ''; if ($this->_header) { $html .= ''; } if (empty($keys)) { $keys = array_keys($this->_values); } else { $keys = explode("\t", $keys['array']); } foreach ($keys as $sl_key) { $html .= ''; } return $html; } function getInfo(&$vars, &$var, &$info) { $value = $vars->get($var->getVarName()); $info = explode("\t", $value['array']); } /** * Return info about field type. */ function about() { return array( 'name' => Horde_Form_Translation::t("Sort order selection"), 'params' => array( 'values' => array('label' => Horde_Form_Translation::t("Values"), 'type' => 'stringarray'), 'size' => array('label' => Horde_Form_Translation::t("Size"), 'type' => 'int'), 'header' => array('label' => Horde_Form_Translation::t("Header"), 'type' => 'text'))); } } class Horde_Form_Type_selectfiles extends Horde_Form_Type { /** * The text to use in the link. * * @var string */ var $_link_text; /** * The style to use for the link. * * @var string */ var $_link_style; /** * Create the link with an icon instead of text? * * @var boolean */ var $_icon; /** * Contains gollem selectfile selectionID * * @var string */ var $_selectid; function init($selectid, $link_text = null, $link_style = '', $icon = false) { $this->_selectid = $selectid; if (is_null($link_text)) { $link_text = Horde_Form_Translation::t("Select Files"); } $this->_link_text = $link_text; $this->_link_style = $link_style; $this->_icon = $icon; } function isValid(&$var, &$vars, $value, &$message) { return true; } function getInfo(&$var, &$vars, &$info) { $value = $vars->getValue($var); $info = $GLOBALS['registry']->call('files/selectlistResults', array($value)); } function about() { return array( 'name' => Horde_Form_Translation::t("File selection"), 'params' => array( 'selectid' => array('label' => Horde_Form_Translation::t("Id"), 'type' => 'text'), 'link_text' => array('label' => Horde_Form_Translation::t("Link text"), 'type' => 'text'), 'link_style' => array('label' => Horde_Form_Translation::t("Link style"), 'type' => 'text'), 'icon' => array('label' => Horde_Form_Translation::t("Show icon?"), 'type' => 'boolean'))); } } class Horde_Form_Type_assign extends Horde_Form_Type { var $_leftValues; var $_rightValues; var $_leftHeader; var $_rightHeader; var $_size; var $_width; function init($leftValues, $rightValues, $leftHeader = '', $rightHeader = '', $size = 8, $width = '200px') { $this->_leftValues = $leftValues; $this->_rightValues = $rightValues; $this->_leftHeader = $leftHeader; $this->_rightHeader = $rightHeader; $this->_size = $size; $this->_width = $width; } function isValid(&$var, &$vars, $value, &$message) { return true; } function getValues($side) { return $side ? $this->_rightValues : $this->_leftValues; } function setValues($side, $values) { if ($side) { $this->_rightValues = $values; } else { $this->_leftValues = $values; } } function getHeader($side) { return $side ? $this->_rightHeader : $this->_leftHeader; } function getSize() { return $this->_size; } function getWidth() { return $this->_width; } function getOptions($side, $formname, $varname) { $html = ''; $headers = false; if ($side) { $values = $this->_rightValues; if (!empty($this->_rightHeader)) { $values = array('' => $this->_rightHeader) + $values; $headers = true; } } else { $values = $this->_leftValues; if (!empty($this->_leftHeader)) { $values = array('' => $this->_leftHeader) + $values; $headers = true; } } foreach ($values as $key => $val) { $html .= '