sw/phplib/datefunc.inc

<?php
//$Header: /home/dashley/cvsrep/e3ft_gpl01/e3ft_gpl01/webprojs/fboprime/sw/phplib/datefunc.inc,v 1.10 2006/08/01 23:14:06 dashley Exp $
//********************************************************************************
//Copyright (C)2006 David T. Ashley
//********************************************************************************
//This program or source file is free software; you can redistribute it and/or 
//modify it under the terms of the GNU General Public License as published by
//the Free Software Foundation; either version 2 of the License, or (at your 
//option) any later version.
//
//This program or source file is distributed in the hope that it will 
//be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.
//
//You may have received a copy of the GNU General Public License
//along with this program; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//********************************************************************************
//Dave Ashley, 04/06
//-------------------------------------------------------------------------------------------------
//Copyright 2006 David T. Ashley
//-------------------------------------------------------------------------------------------------
//This source code and any program in which it is compiled/used is provided under the GNU GENERAL
//PUBLIC LICENSE, Version 3, full license text below.
//-------------------------------------------------------------------------------------------------
//                    GNU GENERAL PUBLIC LICENSE
//                       Version 3, 29 June 2007
//
// Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
// Everyone is permitted to copy and distribute verbatim copies
// of this license document, but changing it is not allowed.
//
//                            Preamble
//
//  The GNU General Public License is a free, copyleft license for
//software and other kinds of works.
//
//  The licenses for most software and other practical works are designed
//to take away your freedom to share and change the works.  By contrast,
//the GNU General Public License is intended to guarantee your freedom to
//share and change all versions of a program--to make sure it remains free
//software for all its users.  We, the Free Software Foundation, use the
//GNU General Public License for most of our software; it applies also to
//any other work released this way by its authors.  You can apply it to
//your programs, too.
//
//  When we speak of free software, we are referring to freedom, not
//price.  Our General Public Licenses are designed to make sure that you
//have the freedom to distribute copies of free software (and charge for
//them if you wish), that you receive source code or can get it if you
//want it, that you can change the software or use pieces of it in new
//free programs, and that you know you can do these things.
//
//  To protect your rights, we need to prevent others from denying you
//these rights or asking you to surrender the rights.  Therefore, you have
//certain responsibilities if you distribute copies of the software, or if
//you modify it: responsibilities to respect the freedom of others.
//
//  For example, if you distribute copies of such a program, whether
//gratis or for a fee, you must pass on to the recipients the same
//freedoms that you received.  You must make sure that they, too, receive
//or can get the source code.  And you must show them these terms so they
//know their rights.
//
//  Developers that use the GNU GPL protect your rights with two steps:
//(1) assert copyright on the software, and (2) offer you this License
//giving you legal permission to copy, distribute and/or modify it.
//
//  For the developers' and authors' protection, the GPL clearly explains
//that there is no warranty for this free software.  For both users' and
//authors' sake, the GPL requires that modified versions be marked as
//changed, so that their problems will not be attributed erroneously to
//authors of previous versions.
//
//  Some devices are designed to deny users access to install or run
//modified versions of the software inside them, although the manufacturer
//can do so.  This is fundamentally incompatible with the aim of
//protecting users' freedom to change the software.  The systematic
//pattern of such abuse occurs in the area of products for individuals to
//use, which is precisely where it is most unacceptable.  Therefore, we
//have designed this version of the GPL to prohibit the practice for those
//products.  If such problems arise substantially in other domains, we
//stand ready to extend this provision to those domains in future versions
//of the GPL, as needed to protect the freedom of users.
//
//  Finally, every program is threatened constantly by software patents.
//States should not allow patents to restrict development and use of
//software on general-purpose computers, but in those that do, we wish to
//avoid the special danger that patents applied to a free program could
//make it effectively proprietary.  To prevent this, the GPL assures that
//patents cannot be used to render the program non-free.
//
//  The precise terms and conditions for copying, distribution and
//modification follow.
//
//                       TERMS AND CONDITIONS
//
//  0. Definitions.
//
//  "This License" refers to version 3 of the GNU General Public License.
//
//  "Copyright" also means copyright-like laws that apply to other kinds of
//works, such as semiconductor masks.
//
//  "The Program" refers to any copyrightable work licensed under this
//License.  Each licensee is addressed as "you".  "Licensees" and
//"recipients" may be individuals or organizations.
//
//  To "modify" a work means to copy from or adapt all or part of the work
//in a fashion requiring copyright permission, other than the making of an
//exact copy.  The resulting work is called a "modified version" of the
//earlier work or a work "based on" the earlier work.
//
//  A "covered work" means either the unmodified Program or a work based
//on the Program.
//
//  To "propagate" a work means to do anything with it that, without
//permission, would make you directly or secondarily liable for
//infringement under applicable copyright law, except executing it on a
//computer or modifying a private copy.  Propagation includes copying,
//distribution (with or without modification), making available to the
//public, and in some countries other activities as well.
//
//  To "convey" a work means any kind of propagation that enables other
//parties to make or receive copies.  Mere interaction with a user through
//a computer network, with no transfer of a copy, is not conveying.
//
//  An interactive user interface displays "Appropriate Legal Notices"
//to the extent that it includes a convenient and prominently visible
//feature that (1) displays an appropriate copyright notice, and (2)
//tells the user that there is no warranty for the work (except to the
//extent that warranties are provided), that licensees may convey the
//work under this License, and how to view a copy of this License.  If
//the interface presents a list of user commands or options, such as a
//menu, a prominent item in the list meets this criterion.
//
//  1. Source Code.
//
//  The "source code" for a work means the preferred form of the work
//for making modifications to it.  "Object code" means any non-source
//form of a work.
//
//  A "Standard Interface" means an interface that either is an official
//standard defined by a recognized standards body, or, in the case of
//interfaces specified for a particular programming language, one that
//is widely used among developers working in that language.
//
//  The "System Libraries" of an executable work include anything, other
//than the work as a whole, that (a) is included in the normal form of
//packaging a Major Component, but which is not part of that Major
//Component, and (b) serves only to enable use of the work with that
//Major Component, or to implement a Standard Interface for which an
//implementation is available to the public in source code form.  A
//"Major Component", in this context, means a major essential component
//(kernel, window system, and so on) of the specific operating system
//(if any) on which the executable work runs, or a compiler used to
//produce the work, or an object code interpreter used to run it.
//
//  The "Corresponding Source" for a work in object code form means all
//the source code needed to generate, install, and (for an executable
//work) run the object code and to modify the work, including scripts to
//control those activities.  However, it does not include the work's
//System Libraries, or general-purpose tools or generally available free
//programs which are used unmodified in performing those activities but
//which are not part of the work.  For example, Corresponding Source
//includes interface definition files associated with source files for
//the work, and the source code for shared libraries and dynamically
//linked subprograms that the work is specifically designed to require,
//such as by intimate data communication or control flow between those
//subprograms and other parts of the work.
//
//  The Corresponding Source need not include anything that users
//can regenerate automatically from other parts of the Corresponding
//Source.
//
//  The Corresponding Source for a work in source code form is that
//same work.
//
//  2. Basic Permissions.
//
//  All rights granted under this License are granted for the term of
//copyright on the Program, and are irrevocable provided the stated
//conditions are met.  This License explicitly affirms your unlimited
//permission to run the unmodified Program.  The output from running a
//covered work is covered by this License only if the output, given its
//content, constitutes a covered work.  This License acknowledges your
//rights of fair use or other equivalent, as provided by copyright law.
//
//  You may make, run and propagate covered works that you do not
//convey, without conditions so long as your license otherwise remains
//in force.  You may convey covered works to others for the sole purpose
//of having them make modifications exclusively for you, or provide you
//with facilities for running those works, provided that you comply with
//the terms of this License in conveying all material for which you do
//not control copyright.  Those thus making or running the covered works
//for you must do so exclusively on your behalf, under your direction
//and control, on terms that prohibit them from making any copies of
//your copyrighted material outside their relationship with you.
//
//  Conveying under any other circumstances is permitted solely under
//the conditions stated below.  Sublicensing is not allowed; section 10
//makes it unnecessary.
//
//  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
//
//  No covered work shall be deemed part of an effective technological
//measure under any applicable law fulfilling obligations under article
//11 of the WIPO copyright treaty adopted on 20 December 1996, or
//similar laws prohibiting or restricting circumvention of such
//measures.
//
//  When you convey a covered work, you waive any legal power to forbid
//circumvention of technological measures to the extent such circumvention
//is effected by exercising rights under this License with respect to
//the covered work, and you disclaim any intention to limit operation or
//modification of the work as a means of enforcing, against the work's
//users, your or third parties' legal rights to forbid circumvention of
//technological measures.
//
//  4. Conveying Verbatim Copies.
//
//  You may convey verbatim copies of the Program's source code as you
//receive it, in any medium, provided that you conspicuously and
//appropriately publish on each copy an appropriate copyright notice;
//keep intact all notices stating that this License and any
//non-permissive terms added in accord with section 7 apply to the code;
//keep intact all notices of the absence of any warranty; and give all
//recipients a copy of this License along with the Program.
//
//  You may charge any price or no price for each copy that you convey,
//and you may offer support or warranty protection for a fee.
//
//  5. Conveying Modified Source Versions.
//
//  You may convey a work based on the Program, or the modifications to
//produce it from the Program, in the form of source code under the
//terms of section 4, provided that you also meet all of these conditions:
//
//    a) The work must carry prominent notices stating that you modified
//    it, and giving a relevant date.
//
//    b) The work must carry prominent notices stating that it is
//    released under this License and any conditions added under section
//    7.  This requirement modifies the requirement in section 4 to
//    "keep intact all notices".
//
//    c) You must license the entire work, as a whole, under this
//    License to anyone who comes into possession of a copy.  This
//    License will therefore apply, along with any applicable section 7
//    additional terms, to the whole of the work, and all its parts,
//    regardless of how they are packaged.  This License gives no
//    permission to license the work in any other way, but it does not
//    invalidate such permission if you have separately received it.
//
//    d) If the work has interactive user interfaces, each must display
//    Appropriate Legal Notices; however, if the Program has interactive
//    interfaces that do not display Appropriate Legal Notices, your
//    work need not make them do so.
//
//  A compilation of a covered work with other separate and independent
//works, which are not by their nature extensions of the covered work,
//and which are not combined with it such as to form a larger program,
//in or on a volume of a storage or distribution medium, is called an
//"aggregate" if the compilation and its resulting copyright are not
//used to limit the access or legal rights of the compilation's users
//beyond what the individual works permit.  Inclusion of a covered work
//in an aggregate does not cause this License to apply to the other
//parts of the aggregate.
//
//  6. Conveying Non-Source Forms.
//
//  You may convey a covered work in object code form under the terms
//of sections 4 and 5, provided that you also convey the
//machine-readable Corresponding Source under the terms of this License,
//in one of these ways:
//
//    a) Convey the object code in, or embodied in, a physical product
//    (including a physical distribution medium), accompanied by the
//    Corresponding Source fixed on a durable physical medium
//    customarily used for software interchange.
//
//    b) Convey the object code in, or embodied in, a physical product
//    (including a physical distribution medium), accompanied by a
//    written offer, valid for at least three years and valid for as
//    long as you offer spare parts or customer support for that product
//    model, to give anyone who possesses the object code either (1) a
//    copy of the Corresponding Source for all the software in the
//    product that is covered by this License, on a durable physical
//    medium customarily used for software interchange, for a price no
//    more than your reasonable cost of physically performing this
//    conveying of source, or (2) access to copy the
//    Corresponding Source from a network server at no charge.
//
//    c) Convey individual copies of the object code with a copy of the
//    written offer to provide the Corresponding Source.  This
//    alternative is allowed only occasionally and noncommercially, and
//    only if you received the object code with such an offer, in accord
//    with subsection 6b.
//
//    d) Convey the object code by offering access from a designated
//    place (gratis or for a charge), and offer equivalent access to the
//    Corresponding Source in the same way through the same place at no
//    further charge.  You need not require recipients to copy the
//    Corresponding Source along with the object code.  If the place to
//    copy the object code is a network server, the Corresponding Source
//    may be on a different server (operated by you or a third party)
//    that supports equivalent copying facilities, provided you maintain
//    clear directions next to the object code saying where to find the
//    Corresponding Source.  Regardless of what server hosts the
//    Corresponding Source, you remain obligated to ensure that it is
//    available for as long as needed to satisfy these requirements.
//
//    e) Convey the object code using peer-to-peer transmission, provided
//    you inform other peers where the object code and Corresponding
//    Source of the work are being offered to the general public at no
//    charge under subsection 6d.
//
//  A separable portion of the object code, whose source code is excluded
//from the Corresponding Source as a System Library, need not be
//included in conveying the object code work.
//
//  A "User Product" is either (1) a "consumer product", which means any
//tangible personal property which is normally used for personal, family,
//or household purposes, or (2) anything designed or sold for incorporation
//into a dwelling.  In determining whether a product is a consumer product,
//doubtful cases shall be resolved in favor of coverage.  For a particular
//product received by a particular user, "normally used" refers to a
//typical or common use of that class of product, regardless of the status
//of the particular user or of the way in which the particular user
//actually uses, or expects or is expected to use, the product.  A product
//is a consumer product regardless of whether the product has substantial
//commercial, industrial or non-consumer uses, unless such uses represent
//the only significant mode of use of the product.
//
//  "Installation Information" for a User Product means any methods,
//procedures, authorization keys, or other information required to install
//and execute modified versions of a covered work in that User Product from
//a modified version of its Corresponding Source.  The information must
//suffice to ensure that the continued functioning of the modified object
//code is in no case prevented or interfered with solely because
//modification has been made.
//
//  If you convey an object code work under this section in, or with, or
//specifically for use in, a User Product, and the conveying occurs as
//part of a transaction in which the right of possession and use of the
//User Product is transferred to the recipient in perpetuity or for a
//fixed term (regardless of how the transaction is characterized), the
//Corresponding Source conveyed under this section must be accompanied
//by the Installation Information.  But this requirement does not apply
//if neither you nor any third party retains the ability to install
//modified object code on the User Product (for example, the work has
//been installed in ROM).
//
//  The requirement to provide Installation Information does not include a
//requirement to continue to provide support service, warranty, or updates
//for a work that has been modified or installed by the recipient, or for
//the User Product in which it has been modified or installed.  Access to a
//network may be denied when the modification itself materially and
//adversely affects the operation of the network or violates the rules and
//protocols for communication across the network.
//
//  Corresponding Source conveyed, and Installation Information provided,
//in accord with this section must be in a format that is publicly
//documented (and with an implementation available to the public in
//source code form), and must require no special password or key for
//unpacking, reading or copying.
//
//  7. Additional Terms.
//
//  "Additional permissions" are terms that supplement the terms of this
//License by making exceptions from one or more of its conditions.
//Additional permissions that are applicable to the entire Program shall
//be treated as though they were included in this License, to the extent
//that they are valid under applicable law.  If additional permissions
//apply only to part of the Program, that part may be used separately
//under those permissions, but the entire Program remains governed by
//this License without regard to the additional permissions.
//
//  When you convey a copy of a covered work, you may at your option
//remove any additional permissions from that copy, or from any part of
//it.  (Additional permissions may be written to require their own
//removal in certain cases when you modify the work.)  You may place
//additional permissions on material, added by you to a covered work,
//for which you have or can give appropriate copyright permission.
//
//  Notwithstanding any other provision of this License, for material you
//add to a covered work, you may (if authorized by the copyright holders of
//that material) supplement the terms of this License with terms:
//
//    a) Disclaiming warranty or limiting liability differently from the
//    terms of sections 15 and 16 of this License; or
//
//    b) Requiring preservation of specified reasonable legal notices or
//    author attributions in that material or in the Appropriate Legal
//    Notices displayed by works containing it; or
//
//    c) Prohibiting misrepresentation of the origin of that material, or
//    requiring that modified versions of such material be marked in
//    reasonable ways as different from the original version; or
//
//    d) Limiting the use for publicity purposes of names of licensors or
//    authors of the material; or
//
//    e) Declining to grant rights under trademark law for use of some
//    trade names, trademarks, or service marks; or
//
//    f) Requiring indemnification of licensors and authors of that
//    material by anyone who conveys the material (or modified versions of
//    it) with contractual assumptions of liability to the recipient, for
//    any liability that these contractual assumptions directly impose on
//    those licensors and authors.
//
//  All other non-permissive additional terms are considered "further
//restrictions" within the meaning of section 10.  If the Program as you
//received it, or any part of it, contains a notice stating that it is
//governed by this License along with a term that is a further
//restriction, you may remove that term.  If a license document contains
//a further restriction but permits relicensing or conveying under this
//License, you may add to a covered work material governed by the terms
//of that license document, provided that the further restriction does
//not survive such relicensing or conveying.
//
//  If you add terms to a covered work in accord with this section, you
//must place, in the relevant source files, a statement of the
//additional terms that apply to those files, or a notice indicating
//where to find the applicable terms.
//
//  Additional terms, permissive or non-permissive, may be stated in the
//form of a separately written license, or stated as exceptions;
//the above requirements apply either way.
//
//  8. Termination.
//
//  You may not propagate or modify a covered work except as expressly
//provided under this License.  Any attempt otherwise to propagate or
//modify it is void, and will automatically terminate your rights under
//this License (including any patent licenses granted under the third
//paragraph of section 11).
//
//  However, if you cease all violation of this License, then your
//license from a particular copyright holder is reinstated (a)
//provisionally, unless and until the copyright holder explicitly and
//finally terminates your license, and (b) permanently, if the copyright
//holder fails to notify you of the violation by some reasonable means
//prior to 60 days after the cessation.
//
//  Moreover, your license from a particular copyright holder is
//reinstated permanently if the copyright holder notifies you of the
//violation by some reasonable means, this is the first time you have
//received notice of violation of this License (for any work) from that
//copyright holder, and you cure the violation prior to 30 days after
//your receipt of the notice.
//
//  Termination of your rights under this section does not terminate the
//licenses of parties who have received copies or rights from you under
//this License.  If your rights have been terminated and not permanently
//reinstated, you do not qualify to receive new licenses for the same
//material under section 10.
//
//  9. Acceptance Not Required for Having Copies.
//
//  You are not required to accept this License in order to receive or
//run a copy of the Program.  Ancillary propagation of a covered work
//occurring solely as a consequence of using peer-to-peer transmission
//to receive a copy likewise does not require acceptance.  However,
//nothing other than this License grants you permission to propagate or
//modify any covered work.  These actions infringe copyright if you do
//not accept this License.  Therefore, by modifying or propagating a
//covered work, you indicate your acceptance of this License to do so.
//
//  10. Automatic Licensing of Downstream Recipients.
//
//  Each time you convey a covered work, the recipient automatically
//receives a license from the original licensors, to run, modify and
//propagate that work, subject to this License.  You are not responsible
//for enforcing compliance by third parties with this License.
//
//  An "entity transaction" is a transaction transferring control of an
//organization, or substantially all assets of one, or subdividing an
//organization, or merging organizations.  If propagation of a covered
//work results from an entity transaction, each party to that
//transaction who receives a copy of the work also receives whatever
//licenses to the work the party's predecessor in interest had or could
//give under the previous paragraph, plus a right to possession of the
//Corresponding Source of the work from the predecessor in interest, if
//the predecessor has it or can get it with reasonable efforts.
//
//  You may not impose any further restrictions on the exercise of the
//rights granted or affirmed under this License.  For example, you may
//not impose a license fee, royalty, or other charge for exercise of
//rights granted under this License, and you may not initiate litigation
//(including a cross-claim or counterclaim in a lawsuit) alleging that
//any patent claim is infringed by making, using, selling, offering for
//sale, or importing the Program or any portion of it.
//
//  11. Patents.
//
//  A "contributor" is a copyright holder who authorizes use under this
//License of the Program or a work on which the Program is based.  The
//work thus licensed is called the contributor's "contributor version".
//
//  A contributor's "essential patent claims" are all patent claims
//owned or controlled by the contributor, whether already acquired or
//hereafter acquired, that would be infringed by some manner, permitted
//by this License, of making, using, or selling its contributor version,
//but do not include claims that would be infringed only as a
//consequence of further modification of the contributor version.  For
//purposes of this definition, "control" includes the right to grant
//patent sublicenses in a manner consistent with the requirements of
//this License.
//
//  Each contributor grants you a non-exclusive, worldwide, royalty-free
//patent license under the contributor's essential patent claims, to
//make, use, sell, offer for sale, import and otherwise run, modify and
//propagate the contents of its contributor version.
//
//  In the following three paragraphs, a "patent license" is any express
//agreement or commitment, however denominated, not to enforce a patent
//(such as an express permission to practice a patent or covenant not to
//sue for patent infringement).  To "grant" such a patent license to a
//party means to make such an agreement or commitment not to enforce a
//patent against the party.
//
//  If you convey a covered work, knowingly relying on a patent license,
//and the Corresponding Source of the work is not available for anyone
//to copy, free of charge and under the terms of this License, through a
//publicly available network server or other readily accessible means,
//then you must either (1) cause the Corresponding Source to be so
//available, or (2) arrange to deprive yourself of the benefit of the
//patent license for this particular work, or (3) arrange, in a manner
//consistent with the requirements of this License, to extend the patent
//license to downstream recipients.  "Knowingly relying" means you have
//actual knowledge that, but for the patent license, your conveying the
//covered work in a country, or your recipient's use of the covered work
//in a country, would infringe one or more identifiable patents in that
//country that you have reason to believe are valid.
//
//  If, pursuant to or in connection with a single transaction or
//arrangement, you convey, or propagate by procuring conveyance of, a
//covered work, and grant a patent license to some of the parties
//receiving the covered work authorizing them to use, propagate, modify
//or convey a specific copy of the covered work, then the patent license
//you grant is automatically extended to all recipients of the covered
//work and works based on it.
//
//  A patent license is "discriminatory" if it does not include within
//the scope of its coverage, prohibits the exercise of, or is
//conditioned on the non-exercise of one or more of the rights that are
//specifically granted under this License.  You may not convey a covered
//work if you are a party to an arrangement with a third party that is
//in the business of distributing software, under which you make payment
//to the third party based on the extent of your activity of conveying
//the work, and under which the third party grants, to any of the
//parties who would receive the covered work from you, a discriminatory
//patent license (a) in connection with copies of the covered work
//conveyed by you (or copies made from those copies), or (b) primarily
//for and in connection with specific products or compilations that
//contain the covered work, unless you entered into that arrangement,
//or that patent license was granted, prior to 28 March 2007.
//
//  Nothing in this License shall be construed as excluding or limiting
//any implied license or other defenses to infringement that may
//otherwise be available to you under applicable patent law.
//
//  12. No Surrender of Others' Freedom.
//
//  If 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 convey a
//covered work so as to satisfy simultaneously your obligations under this
//License and any other pertinent obligations, then as a consequence you may
//not convey it at all.  For example, if you agree to terms that obligate you
//to collect a royalty for further conveying from those to whom you convey
//the Program, the only way you could satisfy both those terms and this
//License would be to refrain entirely from conveying the Program.
//
//  13. Use with the GNU Affero General Public License.
//
//  Notwithstanding any other provision of this License, you have
//permission to link or combine any covered work with a work licensed
//under version 3 of the GNU Affero General Public License into a single
//combined work, and to convey the resulting work.  The terms of this
//License will continue to apply to the part which is the covered work,
//but the special requirements of the GNU Affero General Public License,
//section 13, concerning interaction through a network will apply to the
//combination as such.
//
//  14. Revised Versions of this License.
//
//  The Free Software Foundation may publish revised and/or new versions of
//the GNU General Public License from time to time.  Such new versions will
//be similar in spirit to the present version, but may differ in detail to
//address new problems or concerns.
//
//  Each version is given a distinguishing version number.  If the
//Program specifies that a certain numbered version of the GNU General
//Public License "or any later version" applies to it, you have the
//option of following the terms and conditions either of that numbered
//version or of any later version published by the Free Software
//Foundation.  If the Program does not specify a version number of the
//GNU General Public License, you may choose any version ever published
//by the Free Software Foundation.
//
//  If the Program specifies that a proxy can decide which future
//versions of the GNU General Public License can be used, that proxy's
//public statement of acceptance of a version permanently authorizes you
//to choose that version for the Program.
//
//  Later license versions may give you additional or different
//permissions.  However, no additional obligations are imposed on any
//author or copyright holder as a result of your choosing to follow a
//later version.
//
//  15. Disclaimer of Warranty.
//
//  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
//APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
//HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
//OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
//THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
//IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
//ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
//
//  16. Limitation of Liability.
//
//  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
//WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
//THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
//GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
//USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
//DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
//PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
//EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
//SUCH DAMAGES.
//
//  17. Interpretation of Sections 15 and 16.
//
//  If the disclaimer of warranty and limitation of liability provided
//above cannot be given local legal effect according to their terms,
//reviewing courts shall apply local law that most closely approximates
//an absolute waiver of all civil liability in connection with the
//Program, unless a warranty or assumption of liability accompanies a
//copy of the Program in return for a fee.
//
//                     END OF TERMS AND CONDITIONS
//
//            How to Apply These Terms to Your New Programs
//
//  If you develop a new program, and you want it to be of the greatest
//possible use to the public, the best way to achieve this is to make it
//free software which everyone can redistribute and change under these terms.
//
//  To do so, attach the following notices to the program.  It is safest
//to attach them to the start of each source file to most effectively
//state the exclusion of warranty; and each file should have at least
//the "copyright" line and a pointer to where the full notice is found.
//
//    <one line to give the program's name and a brief idea of what it does.>
//    Copyright (C) <year>  <name of author>
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
//Also add information on how to contact you by electronic and paper mail.
//
//  If the program does terminal interaction, make it output a short
//notice like this when it starts in an interactive mode:
//
//    <program>  Copyright (C) <year>  <name of author>
//    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
//    This is free software, and you are welcome to redistribute it
//    under certain conditions; type `show c' for details.
//
//The hypothetical commands `show w' and `show c' should show the appropriate
//parts of the General Public License.  Of course, your program's commands
//might be different; for a GUI interface, you would use an "about box".
//
//  You should also get your employer (if you work as a programmer) or school,
//if any, to sign a "copyright disclaimer" for the program, if necessary.
//For more information on this, and how to apply and follow the GNU GPL, see
//<http://www.gnu.org/licenses/>.
//
//  The GNU General Public License does not permit incorporating your program
//into proprietary programs.  If your program is a subroutine library, you
//may consider it more useful to permit linking proprietary applications with
//the library.  If this is what you want to do, use the GNU Lesser General
//Public License instead of this License.  But first, please read
//<http://www.gnu.org/philosophy/why-not-lgpl.html>.
//-------------------------------------------------------------------------------------------------
//
//This source file contains date and time calculation and
//manipulation functions.
//
require_once("config.inc");            //Scheduling configuration.
require_once("confighard.inc");        //Necessary for date minimums and maximums.
//
//================================================================================
//================================================================================
//====  R A W    C A L C U L A T I O N  ==========================================
//================================================================================
//================================================================================
//Returns the number of days in the year.
//
//Unit-tested 20060408.
//
function DATEFUNC_year_days($year)
   {
   //May need to be changed if confighard.inc is modified for a longer calendar
   //range.
   $mod_4   = $year %   4;
   $mod_100 = $year % 100;
   $mod_400 = $year % 400;

   if ($mod_4 != 0)
      {
      //We can't have a leap year unless it is divisible by 4.
      return(365);
      }
   else if (($mod_100 == 0) && ($mod_400 != 0))
      {
      //Divisible by 100 and not divible by 400.  Not a leap year.
      return(365);
      }
   else
      {
      //Divisible by 4 and not meeting the exception case:  leap year.
      return(366);
      }
   }
//
//
//--------------------------------------------------------------------------------
//Returns the number of days in all years preceding but not including the
//start year.  This is used for modulo arithmetic to determine day of week
//and so on.  An array is much faster (I think and hope) than an iterative method
//involving summing the years.
//
//Note:  this function has not yet been unit-tested (after it was changed from
//a lookup table).  This is still todo.
//
function DATEFUNC_year_predecessor_sum($year_in)
   {
   //Customized for lower limit of 1700, upper limit if 2300.
   //
   if (($year_in >= CONFIGHARD_DATEFUNC_MINYEAR) && ($year_in < CONFIGHARD_DATEFUNC_MAXYEAR))
      {
      //In year $year_in, the number of prior years where the year was divisible
      //by 4 is given by the expression below.
      if ($year_in == CONFIGHARD_DATEFUNC_MINYEAR)
         {
         $years_prior_div_4 = 0;   
         }
      else
         {
         $years_prior_div_4 = (int)(($year_in - 1 - CONFIGHARD_DATEFUNC_MINYEAR) / 4);   
            //Verified in the PHP docs that cast to int from float behaves with classic
            //div behavior (rounding down), so will be OK.
         }

      //Correct for the fact that 1800, 1900, 2100, and 2200 are not leap years, but 2000 is.
      if (($year_in > 1800) && ($year_in <= 1900))
         {
         //1800 was not a leap year, so we need to deduct 1 from the total leap years encountered.
         $years_prior_div_4 -= 1;
         }
      else if (($year_in > 1900) && ($year_in <= 2100))
         {
         //1800 was not a leap year, and 1900 was not a leap year (but 2000 was),
         //so we need to deduct 2 from the total leap years encountered.
         $years_prior_div_4 -= 2;
         }
      else if (($year_in > 2100) && ($year_in <= 2200))
         {
         //1800, 1900, and 2100 were not leap years (but 2000 was),
         //so we need to deduct 3 from the total leap years encountered.
         $years_prior_div_4 -= 3;
         }
      else /* if (($year_in > 2200) && ($year_in <= 2300)) */
         {
         //1800, 1900, 2100, and 2200 were not leap years (but 2000 was),
         //so we need to deduct 4 from the total leap years encountered.
         $years_prior_div_4 -= 4;
         }

      //The total number of days in years prior is going to be 365 times the number
      //of years prior, except we need to add a day for each leap year prior.
      if ($year_in == CONFIGHARD_DATEFUNC_MINYEAR)
         {
         return(0);
         }
      else
         {
         return((int)(($year_in - CONFIGHARD_DATEFUNC_MINYEAR) * 365 + $years_prior_div_4));
         }
      }
   else
      {
      //Not a year we can calculate about.  Don't want to error-trap at such a 
      //low level.  Just return zero.
      return(0);
      }
   }
//
//
//--------------------------------------------------------------------------------
//Calculates the number of days in a given month of a given year.  Years are
//2000 ... (i.e. full-sized integer), and months are referenced in the traditional 
//way, 1..12.
//
//Unit-tested 20060408.
//
function DATEFUNC_year_month_days($year, $month)
   {
   switch ($month)
      {
      default:
      case 1:
         return(31);
         break;
      case 2:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(28);
            }
         else
            {
            return(29);
            }
         break;
      case 3:
         return(31);
         break;
      case 4:
         return(30);
         break;
      case 5:
         return(31);
         break;
      case 6:
         return(30);
         break;
      case 7:
         return(31);
         break;
      case 8:
         return(31);
         break;
      case 9:
         return(30);
         break;
      case 10:
         return(31);
         break;
      case 11:
         return(30);
         break;
      case 12:
         return(31);
         break;
      }
   }
//
//
//--------------------------------------------------------------------------------
//Calcualtes the Julian offset of a date within a certain year.  The offset
//of January 1 of any year is 0.  Year, month, and day are 2000 ..., 1 ..., and
//1 ..., respectively.
//
//Unit-tested 20060408.
//
function DATEFUNC_year_julian_offset($year, $month, $day)
   {
   switch ($month)
      {
      default:
      case 1:
         return($day - 1);
         break;
      case 2:
         return(31 + $day - 1);
      case 3:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(59 + $day - 1);
            }
         else
            {
            return(59 + $day);
            }
         break;
      case 4:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(90 + $day - 1);
            }
         else
            {
            return(90 + $day);
            }
         break;
      case 5:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(120 + $day - 1);
            }
         else
            {
            return(120 + $day);
            }
         break;
      case 6:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(151 + $day - 1);
            }
         else
            {
            return(151 + $day);
            }
         break;
      case 7:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(181 + $day - 1);
            }
         else
            {
            return(181 + $day);
            }
         break;
      case 8:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(212 + $day - 1);
            }
         else
            {
            return(212 + $day);
            }
         break;
      case 9:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(243 + $day - 1);
            }
         else
            {
            return(243 + $day);
            }
         break;
      case 10:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(273 + $day - 1);
            }
         else
            {
            return(273 + $day);
            }
         break;
      case 11:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(304 + $day - 1);
            }
         else
            {
            return(304 + $day);
            }
         break;
      case 12:
         if (DATEFUNC_year_days($year) == 365)
            {
            return(334 + $day - 1);
            }
         else
            {
            return(334 + $day);
            }
         break;
      }
   }
//
//
//--------------------------------------------------------------------------------
//Given year, month, and day (2000 ..., 1 ..., 1 ...), returns an integer
//representing the day of the week.
//   0   : Sunday
//   1   : Monday
//   2   : Tuesday
//   3   : Wednesday
//   4   : Thursday
//   5   : Friday
//   6   : Saturday
//
//Unit-tested 20060408.
//
function DATEFUNC_intdayofweek_intdate($year, $month, $day)
   {
   $int_differential =     CONFIGHARD_DATEFUNC_EPOCH_DOW
                        +  DATEFUNC_year_predecessor_sum($year)
                        +  DATEFUNC_year_julian_offset($year, $month, $day);
   return($int_differential % 7);
   }
//--------------------------------------------------------------------------------
//Compares two dates, expressed as integers.  Both must be properly formatted
//(i.e. valid years, months, and days).  Returns:
//   -1 if a  < b.
//    0 if a == b.
//    1 if a  > b.
//
function DATEFUNC_cmp($ya, $ma, $da, $yb, $mb, $db)
   {
   if ($ya < $yb)
      {
      return(-1);
      }
   else if ($ya > $yb)
      {
      return(1);
      }
   else
      {
      if ($ma < $mb)
         {
         return(-1);
         }
      else if ($ma > $mb)
         {
         return(1);
         }
      else
         {
         if ($da < $db)
            {
            return(-1);
            }
         else if ($da > $db)
            {
            return(1);
            }
         else
            {
            return(0);
            }
         }
      }
   }
//
//
//--------------------------------------------------------------------------------
//Given a year, a month, and a month offset, moves the passed date backward
//(in the case of negative month offset) or forward (in the case of positive
//month offset) and calculates a new year and month.  The calculated returned
//value will not go outside the range set in CONFIGHARD.INC for the
//scheduling range.
//
//A result flag is set to:
//   -1 : If the result had to be clipped because it went outside the calendar
//        functionality window.
//    0 : If the result did not have to be clipped.
//    1 : If the result had to be clipped because it went outside the calendar
//        functionality window.
//
//The values passed in must be valid.
//
//The ordinal month approach is used because integer math tends to be
//very fast.
//
function DATEFUNC_offset_month($year_in, $month_in, $month_offset_in, &$year_out, &$month_out, &$result_out)
   {
   //Default value of result.
   $result_out = 0;

   //Create ordinal month representations of the min and max allowable months.  Using this
   //scheme, the 0'th month would be January of 0 A.D.
   $min_ordinal_month   = CONFIGHARD_DATEFUNC_MINYEAR * 12;
   $max_ordinal_month   = CONFIGHARD_DATEFUNC_MAXYEAR * 12 - 1;

   //Create ordinal month representation of the input year, month.
   $in_ordinal_month    = $year_in * 12 + $month_in - 1;

   //Create the ordinal month reprsentation of the input + offset.
   $calcd_ordinal_month = $in_ordinal_month + $month_offset_in;

   //Clip the result to be within the scheduling range of the FBO-prime software.
   if ($calcd_ordinal_month < $min_ordinal_month)
      {
      $calcd_ordinal_month = $min_ordinal_month;
      $result_out = -1;
      }
   else if ($calcd_ordinal_month > $max_ordinal_month)
      {
      $calcd_ordinal_month = $max_ordinal_month;
      $result_out = 1;
      }

   //Convert back to calendar year and month format.
   $year_out  =  (int) ($calcd_ordinal_month / 12);
   $month_out =  ($calcd_ordinal_month % 12) + 1;
   }
//
//
//--------------------------------------------------------------------------------
//Calculates the date one week ago.  The date passed in must be within the
//calendaring range and the date one week before must be also within
//calendaring range.
//
function DATEFUNC_one_week_ago($year_in, $month_in, $day_in, &$year_out, &$month_out, &$day_out)
   {
   if (($day_in - 7) > 0)
      {
      //Simplest case.  Different date within the same month.
      $year_out  = $year_in;
      $month_out = $month_in;
      $day_out   = $day_in - 7;
      }
   else
      {
      //Have to roll the month backwards.
      if ($month_in > 1)
         {
         //Have to roll day and month backwards, but not the year.
         $year_out  = $year_in;
         $month_out = $month_in - 1;
         $day_out   = $day_in - 7 + DATEFUNC_year_month_days($year_in, $month_in - 1);
         }
      else
         {
         //Have to roll back the day, month, and year.
         $year_out  = $year_in - 1;
         $month_out = 12;
         $day_out   = $day_in - 7 + DATEFUNC_year_month_days($year_in - 1, 12);
         }
      }
   }
//
//--------------------------------------------------------------------------------
//Calculates the date one week in the future.  The date passed in must be within the
//calendaring range and the date one week in the future must be also within
//calendaring range.
//
function DATEFUNC_one_week_future($year_in, $month_in, $day_in, &$year_out, &$month_out, &$day_out)
   {
   $days_in_month = DATEFUNC_year_month_days($year_in, $month_in);

   if (($day_in + 7) <= $days_in_month)
      {
      //Simplest case.  Different date within the same month.
      $year_out  = $year_in;
      $month_out = $month_in;
      $day_out   = $day_in + 7;
      }
   else
      {
      //Have to roll the month forward.
      if ($month_in < 12)
         {
         //Have to roll day and month forward, but not the year.
         $year_out  = $year_in;
         $month_out = $month_in + 1;
         $day_out   = $day_in + 7 - $days_in_month;
         }
      else
         {
         //Have to roll forward the day, month, and year.
         $year_out  = $year_in + 1;
         $month_out = 1;
         $day_out   = $day_in + 7 - $days_in_month;
         }
      }
   }
//
//--------------------------------------------------------------------------------
//Calculates the date one day ago.  The date passed in must be within the
//calendaring range and the date one day before must be also within
//calendaring range.
//
function DATEFUNC_one_day_ago($year_in, $month_in, $day_in, &$year_out, &$month_out, &$day_out)
   {
   if ($day_in > 1)
      {
      //Simplest case.  Different date within the same month.
      $year_out  = $year_in;
      $month_out = $month_in;
      $day_out   = $day_in - 1;
      }
   else
      {
      //Have to roll the month backwards.
      if ($month_in > 1)
         {
         //Have to roll day and month backwards, but not the year.
         $year_out  = $year_in;
         $month_out = $month_in - 1;
         $day_out   = DATEFUNC_year_month_days($year_in, $month_in - 1);
         }
      else
         {
         //Have to roll back the day, month, and year.
         $year_out  = $year_in - 1;
         $month_out = 12;
         $day_out   = DATEFUNC_year_month_days($year_in - 1, 12);
         }
      }
   }
//
//--------------------------------------------------------------------------------
//Calculates the date one day in the future.  The date passed in must be within the
//calendaring range and the date one day in the future must be also within
//calendaring range.
//
function DATEFUNC_one_day_future($year_in, $month_in, $day_in, &$year_out, &$month_out, &$day_out)
   {
   $days_in_month = DATEFUNC_year_month_days($year_in, $month_in);

   if ($day_in < $days_in_month)
      {
      //Simplest case.  Different date within the same month.
      $year_out  = $year_in;
      $month_out = $month_in;
      $day_out   = $day_in + 1;
      }
   else
      {
      //Have to roll the month forwards.
      if ($month_in < 12)
         {
         //Have to roll day and month forward, but not the year.
         $year_out  = $year_in;
         $month_out = $month_in + 1;
         $day_out   = 1;
         }
      else
         {
         //Have to roll forward the day, month, and year.
         $year_out  = $year_in + 1;
         $month_out = 1;
         $day_out   = 1;
         }
      }
   }
//
//--------------------------------------------------------------------------------
//Given a year and a month, indicates whether it is within the window of
//what should be viewable for scheduling.
//
//The criteria for displaying the month are:
//  a)The month is not outside the calendaring functionality window.
//  b)The month is not outside the parameters set by the 
//    configuration constants CONFIG_SCHED_SCHEDACC_PREV_MO or
//    CONFIG_SCHED_SCHEDACC_FUTU_MO, which specify how many months
//    previous and future may be viewed.
//
//Returns:
//    -1     :   If the year/month is too early to be
//               schedulable.
//     0     :   If the year/month should be schedulable.
//     1     :   If the year/month is too late to be schedulable.
//
function DATEFUNC_is_not_displayable($year_in, $month_in)
   {
   global $GLOBAL_stime_year;
   global $GLOBAL_stime_month;

   //If the year is out of bounds, it is a no-go.
   if ($year_in < CONFIGHARD_DATEFUNC_MINYEAR)
      return(-1);
   else if ($year_in >= CONFIGHARD_DATEFUNC_MAXYEAR)
      return(1);

   //If the month is out of bounds, it is a no-go.
   if (($month_in < 1) || ($month_in > 12))
      return(1);  //Arbitrary, as long as it isn't 0.

   //For reference, find the year/month that is CONFIG_SCHED_SCHEDACC_PREV_MO
   //behind the passed year/month.  If this is clipped, no harm done.
   DATEFUNC_offset_month($GLOBAL_stime_year, 
                         $GLOBAL_stime_month, 
                         -CONFIG_SCHED_SCHEDACC_PREV_MO, 
                         $year_lower_limit, 
                         $month_lower_limit, 
                         $result_flag);

   //For reference, find the year/month that is CONFIG_SCHED_SCHEDACC_FUTU_MO
   //ahead of the passed year/month.  If this is clipped, no harm done.
   DATEFUNC_offset_month($GLOBAL_stime_year, 
                         $GLOBAL_stime_month, 
                         CONFIG_SCHED_SCHEDACC_FUTU_MO, 
                         $year_upper_limit, 
                         $month_upper_limit, 
                         $result_flag);

   //echo " year upper limit : " . $year_upper_limit . " month_upper_limit : " . $month_upper_limit . " ";

   //If the passed year/month are below the lower limit, this means it isn't
   //displayable.
   if (DATEFUNC_cmp($year_in, $month_in, 1, $year_lower_limit, $month_lower_limit, 1) == -1)
      return(-1);

   //If the passed year/month are above the upper limit, this means it isn't
   //displayable.
   if (DATEFUNC_cmp($year_in, $month_in, 1, $year_upper_limit, $month_upper_limit, 1) == 1)
      return(1);
   
   //If we're here, it is displayable.
   return(0);
   }
//
//================================================================================
//================================================================================
//====  S T R I N G    M A P P I N G  ============================================
//================================================================================
//================================================================================
//
//Returns the string associated with an ordinal month number 1-12.
//
function DATEFUNC_string_month_long($month_no)
   {
   $lookup = array("January",
                   "February",
                   "March",
                   "April",
                   "May",
                   "June",
                   "July",
                   "August",
                   "September",
                   "October",
                   "November",
                   "December");

   if (($month_no < 1) || ($month_no > 12))
      {
      return("INVALID");
      }
   else
      {
      return($lookup[$month_no - 1]);
      } 
   }
//
//--------------------------------------------------------------------------------
//Returns the string associated with a day of the week 0-6.
//
function DATEFUNC_string_dow_long($dow_no)
   {
   $lookup = array("Sunday",
                   "Monday",
                   "Tuesday",
                   "Wednesday",
                   "Thursday",
                   "Friday",
                   "Saturday");

   if (($dow_no < 0) || ($dow_no > 6))
      {
      return("INVALID");
      }
   else
      {
      return($lookup[$dow_no]);
      } 
   }
//--------------------------------------------------------------------------------
//Returns a string representing the standard date, i.e. "January 19, 2009" or 
//whatever.
//
function DATEFUNC_stdlongdate($year, $month, $day)
   {
   return(DATEFUNC_string_month_long($month) . " " . $day . ", " . $year);
   }
//
//--------------------------------------------------------------------------------
//Returns a string representing the standard date with day of the week, 
//i.e. "Friday, January 19, 2009" or whatever.
//
function DATEFUNC_stdlongdate_w_dow($year, $month, $day)
   {
   $dow = DATEFUNC_intdayofweek_intdate($year, $month, $day);
   return(  DATEFUNC_string_dow_long($dow) 
          . ", " 
          . DATEFUNC_string_month_long($month) 
          . " " 
          . $day 
          . ", " 
          . $year);
   }
//
//--------------------------------------------------------------------------------
//Returns a string representing the standard time.  In non-military format,
//this will be something like 5:04 p.m.  In military time, something like
//17:04.
//
function DATEFUNC_stdtimenosec($hour, $minute)
   {
   if (CONFIG_TIME_FORMAT_24HR)
      {
      //24-hour format.
      return(sprintf("%02d", $hour) . ":" . sprintf("%02d", $minute));
      }
   else
      {
      //12-hour format.
      if ($hour == 0)
         {
         return(sprintf("%d", 12)    . ":" . sprintf("%02d", $minute) . " a.m.");
         }
      else if ($hour < 12)
         {
         return(sprintf("%d", $hour) . ":" . sprintf("%02d", $minute) . " a.m.");
         }
      else if ($hour == 12)
         {
         return(sprintf("%d", $hour) . ":" . sprintf("%02d", $minute) . " p.m.");
         }
      else
         {
         return(sprintf("%d", $hour - 12) . ":" . sprintf("%02d", $minute) . " p.m.");
         }
      }
   }
//
//--------------------------------------------------------------------------------
//Calculate and return an array of Boolean results to determine whether it is OK
//to view/schedule the indicated date/time.  Each Boolean result is TRUE if it is 
//OK to view/schedule or FALSE if not.
//
//   a)[0] A month ago.
//   b)[1] A week ago.
//   c)[2] A day ago.
//   d)[3] One panel back.
//   e)[4] One panel forward.
//   f)[5] One day forward.
//   g)[6] One week forward.
//   h)[7] One month forward.
//
function DATEFUNC_viewschedtime_differential_array($dispyear, $dispmonth, $dispday,
                                                   $disphour, $dispminute)
   {
   global $CONFIG_SCHED_DAY_PANELS;

   //Default to all FALSE so we don't forget anything.
   //
   $rv = array(FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE, FALSE);

   //NOW
   //---
   //For reference, determine if the base display date passed in is
   //displayable/schedulable.
   //
   if (DATEFUNC_is_not_displayable($dispyear, $dispmonth) == 0)
      $base_date_is_ok = TRUE;
   else
      $base_date_is_ok = FALSE;

   //A MONTH AGO
   //-----------
   //First, try to back off one month to get to the previous month.  If we fail on this
   //(because we're at the lower limit of what the calendar functionality can handle),
   //then we definitely can't display the previous month.
   //
   DATEFUNC_offset_month($dispyear, $dispmonth, -1, $prev_month_year, $prev_month_month, $prev_month_result_code);

   if ($prev_month_result_code == 0)
      {
      //We are not up against the limit of the calendaring functionality.
      //Evaluate the previous month.
      //
      if (DATEFUNC_is_not_displayable($prev_month_year, $prev_month_month) == 0)
         {
         $rv[0] = TRUE;  //Seems OK.
         }
      else
         {
         $rv[0] = FALSE; //Is outside the viewable range.
         }
      }
   else
      {
      //We couldn't back off because we were at the limit.
      $rv[0] = FALSE;
      }

   //A WEEK AGO
   //-----------
   //The logic for a week ago is that if the day of the month is seven or less, the previous
   //month is relevant, else the current month is relevant.
   if ($dispday <= 7)
      $rv[1] = $rv[0];
   else
      $rv[1] = $base_date_is_ok;

   //A DAY AGO
   //-----------
   //The logic for a day ago is that if the day of the month is 1, the previous
   //month is relevant, else the current month is relevant.
   if ($dispday == 1)
      $rv[2] = $rv[0];
   else
      $rv[2] = $base_date_is_ok;

   //ONE PANEL BACK
   //--------------
   //Get the currently appropriate panel.
   $panel = TOD_best_panel($disphour, $dispminute, $CONFIG_SCHED_DAY_PANELS);
   //
   //If the current panel is not 0, backing off the panel won't change the date,
   //and so the passed date's status is the right thing to look at.
   //
   //If the current panel is 0, backing off will move the date to the previous
   //day, and we use that status.
   if ($panel != 0)
      {
      $rv[3] = $base_date_is_ok;
      }
   else
      {
      $rv[3] = $rv[2];
      }

   //A MONTH IN THE FUTURE
   //---------------------
   //First, try to go forward one month to get to the next month.  If we fail on this
   //(because we're at the upper limit of what the calendar functionality can handle),
   //then we definitely can't display the next month.
   //
   DATEFUNC_offset_month($dispyear, $dispmonth, 1, $next_month_year, $next_month_month, $next_month_result_code);

   if ($next_month_result_code == 0)
      {
      //We are not up against the limit of the calendaring functionality.
      //Evaluate the next month.
      //
      if (DATEFUNC_is_not_displayable($next_month_year, $next_month_month) == 0)
         {
         $rv[7] = TRUE;  //Seems OK.
         }
      else
         {
         $rv[7] = FALSE; //Is outside the viewable range.
         }
      }
   else
      {
      //We couldn't go forward because we were at the limit.
      $rv[7] = FALSE;
      }

   //A WEEK IN THE FUTURE
   //--------------------
   //The logic for a week in the future is that if going forward 7 days will put us
   //into the next month, then the validity of that applies, otherwise the
   //validity for the current month applies.
   $days_in_base_month = DATEFUNC_year_month_days($dispyear, $dispmonth);

   if (($dispday + 7) > $days_in_base_month)
      {
      //Get value from next month.
      $rv[6] = $rv[7];
      }
   else
      {
      //Get value from this month.
      $rv[6] = $base_date_is_ok;
      }

   //A DAY IN THE FUTURE
   //-------------------
   //The logic for a day in the future is that if the current day is the last day of
   //the month, then next month's value applies, otherwise this month's
   //value applies.
   if ($dispday >= $days_in_base_month)
      $rv[5] = $rv[7];               //Next month's value.
   else
      $rv[5] = $base_date_is_ok;     //This month's value.

   //ONE PANEL IN THE FUTURE
   //-----------------------
   //If the current panel is not the last one, going to the next panel won't change 
   //the date, and so the passed date's status is the right thing to look at.
   //
   //If the current panel is the last one, going forward will move the date to the 
   //next day, and we use that status.
   $npanels = (int)(count($CONFIG_SCHED_DAY_PANELS) / 2);
   if ($panel >= ($npanels - 1))         //Last penel test.
      {
      $rv[4] = $rv[5];
      }
   else
      {
      $rv[4] = $base_date_is_ok;
      }

   //Return the return value.
   return($rv);
   }
//
//--------------------------------------------------------------------------------
//End of $RCSfile: datefunc.inc,v $.
//--------------------------------------------------------------------------------
?>