TimeTrex Community Edition v16.2.0
This commit is contained in:
commit
472f000c1b
5
.htaccess
Normal file
5
.htaccess
Normal file
@ -0,0 +1,5 @@
|
||||
#Hide all source control related files.
|
||||
RedirectMatch 404 /\\.(svn|git|gitignore|hg|bzr|cvs|gitlab-ci.yml|gitattributes)(/|$)
|
||||
|
||||
#Hide other files that could disclose information with a 403 Forbidden error.
|
||||
RedirectMatch 403 /(composer.json|composer.lock|package.json|package-lock.json)(/|$)
|
||||
51
3rd_party_credits.txt
Normal file
51
3rd_party_credits.txt
Normal file
@ -0,0 +1,51 @@
|
||||
As Of Date Name Path TT V Dist V License Download URL NOTE
|
||||
16-Nov-2019 backbone interface/html5/framework/backbone/backbone-min.js 1.4.0 1.4.0 MIT backbonejs.org
|
||||
16-Nov-2019 json2.js interface/html5/framework/backbone/json2.js 10-25-17 backbonejs.org
|
||||
16-Nov-2019 json2.js interface/html5/framework/json2.js ?? ?? //there's 2 of these. not sure we need this one.
|
||||
16-Nov-2019 underscore interface/html5/framework/backbone/underscore-min.js 1.9.1 1.9.1 MIT http://underscorejs.org/
|
||||
|
||||
16-Nov-2019 bootstrap interface/html5/framework/bootstrap/js/bootstrap.bundle.js 4.3.1 4.3.1 MIT http://getbootstrap.com
|
||||
16-Jun-2020 bootstrap-select interface/html5/framework/bootstrap-select/dist/js/bootstrap-select.js 1.13.15 1.13.15 MIT https://silviomoreto.github.io/bootstrap-select/
|
||||
16-Nov-2019 bootstrap-toolkit interface/html5/framework/bootstrap-toolkit.min.js 2.6.3 2.6.3 MIT https://github.com/maciej-gurban/responsive-bootstrap-toolkit
|
||||
|
||||
12-Sep-2018 leaflet interface/html5/framework/leaflet/leaflet.js 1.3.4 1.3.4 BSD http://leafletjs.com/download.html **We override leaflet and leaflet-routing-machine, so can't use minified code.
|
||||
21-Sep-2018 leaflet-draw interface/html5/framework/leaflet/leaflet-draw 1.0.3 1.0.3 MIT https://github.com/Leaflet/Leaflet.draw Notes: latest 'released' version tagged as v0.4.14 vs available 1.0.3
|
||||
12-Sep-2018 leaflet-providers interface/html5/framework/leaflet/leaflet-providers/leaflet-providers.js 1.4.0 1.4.0 BSD https://github.com/leaflet-extras/leaflet-providers
|
||||
12-Sep-2018 leaflet-routing-machine interface/html5/framework/leaflet/leaflet-routing-machine 3.2.11 3.2.11 ISC http://www.liedman.net/leaflet-routing-machine/ **We override leaflet and leaflet-routing-machine, so can't use minified code.
|
||||
17-Oct-2018 leaflet-markercluster interface/html5/framework/leaflet/leaflet-markercluster 1.4.1 1.4.1 MIT https://github.com/Leaflet/Leaflet.markercluster
|
||||
|
||||
16-Nov-2019 qunit interface/html5/framework/qunit/qunit.js 2.9.2 2.9.2 MIT https://qunitjs.com/
|
||||
16-Nov-2019 rightclickmenu interface/html5/framework/rightclickmenu/rightclickmenu.js 2.7.0 2.9.0 MIT http://swisnl.github.io/jQuery-contextMenu/index.html **Has Custom Modifications!
|
||||
16-Nov-2019 tinymce interface/html5/framework/tinymce/tinymce.min.js 4.9.6 4.9.6 LGPL https://www.tinymce.com/download/
|
||||
|
||||
16-Nov-2019 html2canvas.js interface/html5/framework/html2canvas.js 1.0.0-rc5 1.0.0-rc5 MIT https://github.com/niklasvh/html2canvas/releases
|
||||
|
||||
16-Nov-2019 html5shiv interface/html5/framework/html5shiv.min.js 3.7.3 3.7.3 MIT https://github.com/aFarkas/html5shiv
|
||||
16-Nov-2019 interact.min.js interface/html5/framework/interact.min.js 1.7.1 1.7.1 ASIS interactjs.io (Don't think this is being used anymore)
|
||||
16-Nov-2019 masonry interface/html5/framework/masonry.min.js 4.2.2 4.2.2 MIT http://masonry.desandro.com
|
||||
13-Apr-2018 measurement interface/html5/framework/measurement.js 0.1 0.1 ?? https://github.com/Philzen/measurement.js **Has TT customizations!
|
||||
16-Nov-2019 moment interface/html5/framework/moment.min.js 2.24.0 2.24.0 MIT https://momentjs.com/
|
||||
16-Nov-2019 nanobar interface/html5/framework/nanobar.min.js 0.4.2 0.4.2 MIT https://github.com/jacoborus/nanobar
|
||||
16-Nov-2019 r interface/html5/framework/r.js 2.3.6 2.3.6 BSD https://github.com/requirejs/r.js
|
||||
16-Nov-2019 require interface/html5/framework/require.js 2.3.6 2.3.6 BSD https://raw.githubusercontent.com/requirejs/r.js/master/require.js
|
||||
16-Nov-2019 require_async_plugin interface/html5/framework/require_async_plugin.js 0.1.2 0.1.2 MIT https://github.com/millermedeiros/requirejs-plugins/tree/master/src
|
||||
16-Nov-2019 respond interface/html5/framework/respond.min.js 1.4.2 1.4.2 ASIS https://github.com/scottjehl/Respond
|
||||
16-Nov-2019 sonic interface/html5/framework/sonic.js 0.3 0.3 MIT https://github.com/padolsey/sonic.js
|
||||
16-Nov-2019 color-picker interface/html5/framework/widgets/color-picker 1.1.1 1.1.1 MIT https://github.com/PitPik/tinyColorPicker/blob/master/jqColorPicker.min.js
|
||||
16-Nov-2019 datepicker interface/html5/framework/widgets/datepicker/jquery-ui-timepicker-addon.js 1.6.3 1.6.3 MIT http://trentrichardson.com/examples/timepicker/ https://github.com/trentrichardson/jQuery-Timepicker-Addon
|
||||
16-Nov-2019 free-jqgrid interface/html5/framework/widgets/jqgrid/jquery.jqGrid.min.js 4.15.5 4.15.5 MIT https://github.com/free-jqgrid/jqGrid/releases
|
||||
16-Nov-2019 jquery.jqgrid.winmultiselect interface/html5/framework/widgets/jqgrid/jquery.jqgrid.winmultiselect.js 30-Oct-2017 MIT https://github.com/OlegKi/jqGrid-plugins
|
||||
16-Nov-2019 grid.locale-en.js interface/html5/framework/widgets/jqgrid/grid.locale-en.js ?? ?? ?? ?
|
||||
|
||||
19-Jun-2020 jquery interface/html5/framework/jquery.min.js 3.5.1 3.5.1 ASIS https://github.com/jquery/jquery
|
||||
7-Oct-2021 jqueryui NPM node_modules 1.13.0 1.13.0 MIT http://jqueryui.com/download/
|
||||
|
||||
16-Nov-2019 jquery.qtip interface/html5/framework/jquery.qtip.min.js 3.0.3 3.0.3 MIT https://github.com/Craga89/qTip1 http://qtip2.com/
|
||||
16-Nov-2019 jquery.stickytableheaders interface/html5/framework/jquery.stickytableheaders.min.js 0.1.24 0.1.24 ASIS https://github.com/jmosbech/StickyTableHeaders [Used in HTML reports]
|
||||
16-Nov-2019 jquery.bridget interface/html5/framework/jquery.bridget.js 2.0.1 2.0.1 MIT https://github.com/desandro/jquery-bridget
|
||||
16-Nov-2019 jquery.i18n interface/html5/framework/jquery.i18n.js 1.1.2 1.1.2 AS IS https://github.com/recurser/jquery-i18n -- Modified to fix global variables (04-Feb-20)
|
||||
16-Nov-2019 jquery.imageareaselect interface/html5/framework/jquery.imgareaselect.js 0.9.10 0.9.10 MIT http://odyniec.net/projects/imgareaselect/
|
||||
16-Nov-2019 jquery.json interface/html5/framework/jquery.json.js 2.6.0 2.6.0 MIT https://github.com/Krinkle/jquery-json
|
||||
13-Apr-2018 jquery.tablednd interface/html5/framework/jquery.tablednd.js 1.0.3 1.0.3 MIT https://github.com/isocra/TableDnD
|
||||
08-Dec-2021 gtag.js interface/html5/framework/google/analytics/gtag.js ?? ?? ?? https://www.googletagmanager.com/gtag/js -- We load this locally instead of remotely to catch script errors.
|
||||
16-Nov-2019 decimal interface/html5/framework/decimal.min.js 10.2.0 10.2.0 MIT https://github.com/MikeMcl/decimal.js/
|
||||
1
INSTALL.txt
Normal file
1
INSTALL.txt
Normal file
@ -0,0 +1 @@
|
||||
Please see README.txt
|
||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
1
README.txt
Normal file
1
README.txt
Normal file
@ -0,0 +1 @@
|
||||
For installation and upgrade instructions, please see: https://www.timetrex.com/how-to-install-timetrex
|
||||
2
UPGRADE.txt
Normal file
2
UPGRADE.txt
Normal file
@ -0,0 +1,2 @@
|
||||
Please see "Upgrade Instruction" section in README.txt
|
||||
|
||||
416
api/json/api.php
Normal file
416
api/json/api.php
Normal file
@ -0,0 +1,416 @@
|
||||
<?php
|
||||
/*********************************************************************************
|
||||
*
|
||||
* TimeTrex is a Workforce Management program developed by
|
||||
* TimeTrex Software Inc. Copyright (C) 2003 - 2021 TimeTrex Software Inc.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it under
|
||||
* the terms of the GNU Affero General Public License version 3 as published by
|
||||
* the Free Software Foundation with the addition of the following permission
|
||||
* added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
|
||||
* WORK IN WHICH THE COPYRIGHT IS OWNED BY TIMETREX, TIMETREX DISCLAIMS THE
|
||||
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
|
||||
*
|
||||
* 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 Affero General Public License for more
|
||||
* details.
|
||||
*
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License along
|
||||
* with this program; if not, see http://www.gnu.org/licenses or write to the Free
|
||||
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||
* 02110-1301 USA.
|
||||
*
|
||||
*
|
||||
* You can contact TimeTrex headquarters at Unit 22 - 2475 Dobbin Rd. Suite
|
||||
* #292 West Kelowna, BC V4T 2E9, Canada or at email address info@timetrex.com.
|
||||
*
|
||||
*
|
||||
* The interactive user interfaces in modified source and object code versions
|
||||
* of this program must display Appropriate Legal Notices, as required under
|
||||
* Section 5 of the GNU Affero General Public License version 3.
|
||||
*
|
||||
*
|
||||
* In accordance with Section 7(b) of the GNU Affero General Public License
|
||||
* version 3, these Appropriate Legal Notices must retain the display of the
|
||||
* "Powered by TimeTrex" logo. If the display of the logo is not reasonably
|
||||
* feasible for technical reasons, the Appropriate Legal Notices must display
|
||||
* the words "Powered by TimeTrex".
|
||||
*
|
||||
********************************************************************************/
|
||||
|
||||
define( 'TIMETREX_JSON_API', true );
|
||||
if ( isset( $_GET['disable_db'] ) && $_GET['disable_db'] == 1 ) {
|
||||
$disable_database_connection = true;
|
||||
}
|
||||
//Add timetrex.ini.php setting to enable/disable the API. Make an entire [API] section.
|
||||
require_once( '../../includes/global.inc.php' );
|
||||
require_once( '../../includes/API.inc.php' );
|
||||
Header( 'Content-Type: application/json; charset=UTF-8' ); //Make sure content type is not text/HTML to help avoid XSS.
|
||||
|
||||
|
||||
/**
|
||||
* General handler for service calls, regardless of if the user is logged in or not. Mostly a wrapper to make idempotent request handling consistent across authenticated and unauthenticated calls.
|
||||
* @param $obj
|
||||
* @param $class_name
|
||||
* @param $method
|
||||
* @param $arguments
|
||||
* @param $message_id
|
||||
* @param $api_auth
|
||||
* @param $user_id
|
||||
* @return bool
|
||||
* @throws DBError
|
||||
* @throws GeneralError
|
||||
*/
|
||||
function invokeService( $obj, $class_name, $method, $arguments, $message_id, $api_auth, $user_id ) {
|
||||
try {
|
||||
//Handle idempotent enabled requests here.
|
||||
if ( TTUUID::isUUID( $message_id ) && ( ( isset( $_GET['idempotent'] ) && (int)$_GET['idempotent'] == 1 && strtolower( substr( $method, 0, 3 ) ) != 'get' && strtolower( substr( $method, 0, 8 ) ) != 'validate' ) ) ) { //Don't allow idempotent requests on get*() and validate*() calls.
|
||||
$irf = new IdempotentRequestFactory();
|
||||
$irf->setUser( $user_id );
|
||||
$irf->setIdempotentKey( $obj->getAPIMessageId() );
|
||||
$irf->setStatus( 10 ); //10=Processing
|
||||
$irf->setRequestDate( microtime( true ) );
|
||||
$irf->setRequestMethod( $_SERVER['REQUEST_METHOD'] );
|
||||
$irf->setRequestBody( ( ( $irf->getRequestMethod() == 'GET' ) ? $_GET : ( ( isset( $_SERVER['CONTENT_LENGTH'] ) && $_SERVER['CONTENT_LENGTH'] <= 25000 ) ? $_POST : [ 'request_body_hash' => sha1( json_encode( $_POST ) ) ] ) ) ); //To prevent bloating the database, only save request bodies smaller than 25K.
|
||||
$irf->setRequestURI( $_SERVER['REQUEST_URI'] );
|
||||
if ( $irf->isValid() ) {
|
||||
Debug::text( ' IDEMPOTENT: Enabled and saved! Key: '. $irf->getIdempotentKey(), __FILE__, __LINE__, __METHOD__, 10 );
|
||||
$irf->Save( false, false );
|
||||
if ( $irf->getIsExists() == true ) { //Check if the key already exists in the database.
|
||||
/**
|
||||
* @param $key
|
||||
* @param $user_id
|
||||
* @return array|false
|
||||
*/
|
||||
function getOrWaitForIdempotentResponse( $key, $user_id ) {
|
||||
$irlf = new IdempotentRequestListFactory();
|
||||
$irlf->getByIdempotentKeyAndUserId( $key, $user_id );
|
||||
if ( $irlf->getRecordCount() == 1 ) {
|
||||
$ir_obj = $irlf->getCurrent();
|
||||
if ( $ir_obj->getStatus() == 20 ) {
|
||||
Debug::text( ' IDEMPOTENT: Found saved idempotent response...', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
return [ 'response_body' => $ir_obj->getResponseBody() ];
|
||||
}
|
||||
}
|
||||
|
||||
Debug::text( ' IDEMPOTENT: No saved idempotent response yet...', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
return false;
|
||||
}
|
||||
|
||||
Debug::text( ' IDEMPOTENT: Idempotent Key already exists with Status: ' . $irf->getStatus(), __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
$retry_sleep = 1; //Start at 0.5 seconds retry interval, then use expontential backoff, similar to retryTransaction()
|
||||
$tmp_sleep = ( $retry_sleep * 1000000 );
|
||||
|
||||
$retry_attempts = 0;
|
||||
$retry_max_attempts = 7; //max of 128 seconds delay.
|
||||
while ( $retry_attempts < $retry_max_attempts ) {
|
||||
$irf_response = getOrWaitForIdempotentResponse( $irf->getIdempotentKey(), $user_id );
|
||||
if ( is_array( $irf_response ) && isset( $irf_response['response_body'] ) ) {
|
||||
Debug::text( ' IDEMPOTENT: Sending saved idempotent response... Key: '. $irf->getIdempotentKey(), __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $irf_response['response_body'] );
|
||||
return true;
|
||||
} else {
|
||||
Debug::text( ' IDEMPOTENT: Sleeping for idempotent response before retry... Sleep: '. $tmp_sleep .' Attempt: '. $retry_attempts, __FILE__, __LINE__, __METHOD__, 10 );
|
||||
$random_sleep_interval = ( ceil( ( rand() / getrandmax() ) * ( ( $tmp_sleep * 0.33 ) * 2 ) - ( $tmp_sleep * 0.33 ) ) ); //+/- 33% of the sleep time.
|
||||
|
||||
if ( $retry_attempts < ( $retry_max_attempts - 1 ) ) { //Don't sleep on the last iteration as its serving no purpose.
|
||||
usleep( $tmp_sleep + $random_sleep_interval );
|
||||
}
|
||||
|
||||
$tmp_sleep = ( $tmp_sleep * 2 ); //Exponential back-off with 25% of retry sleep time as a random value.
|
||||
$retry_attempts++;
|
||||
}
|
||||
}
|
||||
unset( $retry_sleep, $tmp_sleep, $retry_attempts, $retry_max_attempts );
|
||||
|
||||
Debug::text( 'IDEMPOTENT: Response not found after maximum retry attempts, original request is likely still being processed!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'Idempotent response not available yet, please try again' ) ) );
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Use array_values() to remove any named parameters and avoid "Uncaught Error: Unknown named parameter" problems on PHP v8+
|
||||
// This can happen when a malformed API call is made with arguments like: [ 'filter_page' => 1, 'filter_items_per_page' => 9999 ], which is sending two named arguments to the function,
|
||||
// instead of: [ 0 => [ 'filter_page' => 1, 'filter_items_per_page' => 9999 ] ], which sends one argument that is an assoc. array.
|
||||
$retval = call_user_func_array( [ $obj, $method ], array_values( (array)$arguments ) );
|
||||
if ( $retval !== null ) {
|
||||
if ( !is_object( $retval ) ) { //Make sure we never return a raw object to end-user, as too much information could be included in it.
|
||||
echo json_encode( $retval );
|
||||
$json_error = getJSONError();
|
||||
if ( $json_error !== false ) {
|
||||
Debug::Arr( $retval, 'ERROR: JSON: ' . $json_error, __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', 'ERROR: JSON: ' . $json_error ) );
|
||||
} else {
|
||||
//Save response for idempotent requests.
|
||||
if ( isset( $irf ) && is_object( $irf ) ) {
|
||||
Debug::text( 'IDEMPOTENT: Updating response to: Completed.', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
$irf->setStatus( 20 ); //20=Completed
|
||||
$irf->setResponseCode( 200 ); //200=OK
|
||||
$irf->setResponseBody( $retval );
|
||||
$irf->setResponseDate( microtime( true ) );
|
||||
if ( $irf->isValid() ) {
|
||||
$irf->Save();
|
||||
}
|
||||
unset( $irf );
|
||||
}
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'OBJECT return value, not JSON encoding any additional data.', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'NULL return value, not JSON encoding any additional data.', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
}
|
||||
} catch ( ArgumentCountError $e ) {
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', $e->getMessage() ) );
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Invoke API methods before the user is authenticated.
|
||||
* @param $class_name
|
||||
* @param $method
|
||||
* @param $arguments
|
||||
* @param $message_id
|
||||
* @param $api_auth
|
||||
* @return bool
|
||||
* @throws ReflectionException
|
||||
*/
|
||||
function unauthenticatedInvokeService( $class_name, $method, $arguments, $message_id, $api_auth ) {
|
||||
global $config_vars;
|
||||
TTi18n::chooseBestLocale(); //Make sure we set the locale as best we can when not logged in
|
||||
|
||||
Debug::text( 'Handling UNAUTHENTICATED JSON Call To API Factory: ' . $class_name . ' Method: ' . $method . ' Message ID: ' . $message_id, __FILE__, __LINE__, __METHOD__, 10 );
|
||||
if ( !isset( $config_vars['other']['down_for_maintenance'] ) || isset( $config_vars['other']['down_for_maintenance'] ) && $config_vars['other']['down_for_maintenance'] == '' ) {
|
||||
$valid_unauthenticated_classes = getUnauthenticatedAPIClasses();
|
||||
if ( $class_name != '' && in_array( $class_name, $valid_unauthenticated_classes ) && class_exists( $class_name ) ) {
|
||||
$obj = new $class_name;
|
||||
|
||||
if ( isWhiteListedAPICall( $obj, $method ) === true ) {
|
||||
if ( method_exists( $obj, 'setAPIMessageID' ) ) {
|
||||
$obj->setAPIMessageID( $message_id ); //Sets API message ID so progress bar continues to work.
|
||||
}
|
||||
if ( $method != '' && method_exists( $obj, $method ) ) {
|
||||
invokeService( $obj, $class_name, $method, $arguments, $message_id, $api_auth, TTUUID::getZeroID() );
|
||||
} else {
|
||||
$validator = TTnew( 'Validator' ); /** @var Validator $validator */
|
||||
Debug::text( 'Class: '. get_class( $obj ) .' Method: ' . $method . ' does not exist!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'SESSION', TTi18n::getText( 'Method: "%1" does not exist.', [ $validator->escapeHTML( $method ) ] ) ) );
|
||||
}
|
||||
} else {
|
||||
$validator = TTnew( 'Validator' ); /** @var Validator $validator */
|
||||
Debug::text( 'Class: '. get_class( $obj ) .' Method: ' . $method . ' is private!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'Method: "%1" is private, unable to call.', [ $validator->escapeHTML( $method ) ] ) ) );
|
||||
}
|
||||
} else {
|
||||
$validator = TTnew( 'Validator' ); /** @var Validator $validator */
|
||||
if ( class_exists( $class_name ) ) {
|
||||
Debug::text( 'Class: ' . $class_name . ' requires authentication! (unauth)', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'SESSION', TTi18n::getText( 'Class: "%1" requires authentication, and not currently authenticated.', [ $validator->escapeHTML( $class_name ) ] ) ) );
|
||||
} else {
|
||||
Debug::text( 'Class: ' . $class_name . ' does not exist! (unauth)', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'SESSION', TTi18n::getText( 'Class: "%1" does not exist.', [ $validator->escapeHTML( $class_name ) ] ) ) );
|
||||
}
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'WARNING: Installer/Down For Maintenance is enabled... Service is disabled!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'DOWN_FOR_MAINTENANCE', TTi18n::gettext( '%1 is currently undergoing maintenance. We apologize for any inconvenience this may cause, please try again later.', [ APPLICATION_NAME ] ) ) );
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Invoke API methods after the user is authenticated.
|
||||
* @param $class_name
|
||||
* @param $method
|
||||
* @param $arguments
|
||||
* @param $message_id
|
||||
* @param $authentication
|
||||
* @param $api_auth
|
||||
* @return bool
|
||||
*/
|
||||
function authenticatedInvokeService( $class_name, $method, $arguments, $message_id, $authentication, $api_auth ) {
|
||||
global $current_user, $current_user_prefs, $current_company, $obj;
|
||||
|
||||
$current_user = $authentication->getObject();
|
||||
|
||||
if ( is_object( $current_user ) ) {
|
||||
$current_user_prefs = handleOverridePreferences( $current_user );
|
||||
|
||||
$clf = new CompanyListFactory();
|
||||
$current_company = $clf->getByID( $current_user->getCompany() )->getCurrent();
|
||||
|
||||
if ( is_object( $current_company ) ) {
|
||||
Debug::text( 'Current User: ' . $current_user->getUserName() . ' (User ID: ' . $current_user->getID() . ') Company: ' . $current_company->getName() . ' (Company ID: ' . $current_company->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
//Debug::text('Handling JSON Call To API Factory: '. $class_name .' Method: '. $method .' Message ID: '. $message_id .' UserName: '. $current_user->getUserName(), __FILE__, __LINE__, __METHOD__, 10);
|
||||
if ( $class_name != '' && class_exists( $class_name ) ) {
|
||||
$obj = new $class_name;
|
||||
|
||||
if ( isWhiteListedAPICall( $obj, $method ) === true ) {
|
||||
if ( method_exists( $obj, 'setAPIMessageID' ) ) {
|
||||
$obj->setAPIMessageID( $message_id ); //Sets API message ID so progress bar continues to work.
|
||||
}
|
||||
|
||||
if ( $method != '' && method_exists( $obj, $method ) ) {
|
||||
invokeService( $obj, $class_name, $method, $arguments, $message_id, $api_auth, $current_user->getId() );
|
||||
} else {
|
||||
Debug::text( 'Method: ' . $method . ' does not exist!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'Method: "%1" does not exist.', [ $current_company->Validator->escapeHTML( $method ) ] ) ) );
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'Method: ' . $method . ' is private!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'Method: "%1" is private, unable to call.', [ $current_company->Validator->escapeHTML( $method ) ] ) ) );
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'Class: ' . $class_name . ' does not exist!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'Class: "%1" does not exist.', [ $current_company->Validator->escapeHTML( $class_name ) ] ) ) );
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'Failed to get Company Object!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'SESSION', TTi18n::getText( 'Company does not exist.' ) ) );
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'Failed to get User Object!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
echo json_encode( $api_auth->returnHandler( false, 'SESSION', TTi18n::getText( 'User does not exist.' ) ) );
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
Arguments:
|
||||
GET: SessionID
|
||||
GET: Class
|
||||
GET: Method
|
||||
POST: Arguments for method.
|
||||
*/
|
||||
$class_prefix = 'API';
|
||||
$class_name = false;
|
||||
$method = false;
|
||||
|
||||
if ( isset( $_GET['Class'] ) && $_GET['Class'] != '' ) {
|
||||
$class_name = $_GET['Class'];
|
||||
|
||||
//If API wasn't already put on the class, add it manually.
|
||||
if ( strtolower( substr( $class_name, 0, 3 ) ) != 'api' ) {
|
||||
$class_name = $class_prefix . $class_name;
|
||||
}
|
||||
|
||||
$class_name = TTgetPluginClassName( $class_name );
|
||||
} else {
|
||||
$class_name = TTgetPluginClassName( $class_prefix . 'Authentication' );
|
||||
}
|
||||
|
||||
if ( isset( $_GET['Method'] ) && $_GET['Method'] != '' ) {
|
||||
$method = $_GET['Method'];
|
||||
}
|
||||
|
||||
if ( isset( $_GET['MessageID'] ) && $_GET['MessageID'] != '' ) {
|
||||
$message_id = $_GET['MessageID'];
|
||||
} else {
|
||||
$message_id = $_GET['MessageID'] = md5( uniqid() ); //Random message_id
|
||||
}
|
||||
|
||||
Debug::text( 'Handling JSON Call To API Factory: ' . $class_name . ' Method: ' . $method . ' Message ID: ' . $message_id, __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
//URL: api.php?SessionID=fc914bf32711bff031a6c80295bbff86&Class=APIPayStub&Method=getPayStub
|
||||
/*
|
||||
RAW POST: data[filter_data][id][0]=101561&paging=TRUE&format=pdf
|
||||
JSON (URL encoded): %7B%22data%22%3A%7B%22filter_data%22%3A%7B%22id%22%3A%5B101561%5D%7D%7D%2C%22paging%22%3Atrue%2C%22format%22%3A%22pdf%22%7D
|
||||
|
||||
FULL URL: SessionID=fc914bf32711bff031a6c80295bbff86&Class=APIPayStub&Method=test&json={"data":{"filter_data":{"id":[101561]}},"paging":true,"format":"pdf"}
|
||||
*/
|
||||
/*
|
||||
$_POST = array( 'data' => array('filter_data' => array('id' => array(101561) ) ),
|
||||
'paging' => TRUE,
|
||||
'format' => 'pdf',
|
||||
);
|
||||
*/
|
||||
//Debug::Arr(file_get_contents('php://input'), 'POST: ', __FILE__, __LINE__, __METHOD__, 10);
|
||||
//Debug::Arr($_POST, 'POST: ', __FILE__, __LINE__, __METHOD__, 10);
|
||||
|
||||
$api_auth = TTNew( 'APIAuthentication' ); /** @var APIAuthentication $api_auth */ //Used to handle error cases and display error messages.
|
||||
|
||||
$argument_size = strlen( $HTTP_RAW_POST_DATA ); //Just strlen this variable rather than serialize all the data as it should be much faster.
|
||||
if ( isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0 ) {
|
||||
if ( (int)$_SERVER['CONTENT_LENGTH'] != $argument_size ) {
|
||||
Debug::Text( 'WARNING: Content Length header: '. $_SERVER['CONTENT_LENGTH'] .' does not match actual content length: ' . $argument_size .'. Request from client is possibly corrupt or cutoff.', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
//TODO: Possibly return an error message to the user to retry?
|
||||
}
|
||||
}
|
||||
|
||||
$arguments = $_POST;
|
||||
if ( isset($_POST['json']) || isset($_GET['json']) ) {
|
||||
if ( isset( $_GET['json'] ) && $_GET['json'] != '' ) {
|
||||
$arguments = json_decode( $_GET['json'], true );
|
||||
} else if ( isset( $_POST['json'] ) && $_POST['json'] != '' ) {
|
||||
$arguments = json_decode( $_POST['json'], true );
|
||||
}
|
||||
|
||||
//Test to see if json_decode() failed for some reason, this should help determine if the argument data is somehow corrupt.
|
||||
if ( $argument_size > 5 && $arguments === null && getJSONError() != '' ) {
|
||||
Debug::Text( 'JSON Error: ' . getJSONError(), __FILE__, __LINE__, __METHOD__, 10 );
|
||||
Debug::Arr( $HTTP_RAW_POST_DATA, 'Raw POST Request: ', __FILE__, __LINE__, __METHOD__, 0 );
|
||||
Debug::Arr( urldecode( $HTTP_RAW_POST_DATA ), 'URL Decoded Raw POST Request: ', __FILE__, __LINE__, __METHOD__, 0 );
|
||||
}
|
||||
} elseif ( $HTTP_RAW_POST_DATA != '' ) {
|
||||
$arguments = json_decode( $HTTP_RAW_POST_DATA, true );
|
||||
if ( $arguments !== null && getJSONError() == '' ) {
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'ERROR: JSON payload must be sent within the \'json\' POST variable. ie: json=<JSON DATA>' ) ) );
|
||||
} else {
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION', TTi18n::getText( 'ERROR: No JSON POST variable payload received. Payload must be sent within the \'json\' POST variable. ie: json=<JSON DATA>' ) ) );
|
||||
}
|
||||
Debug::Arr( urldecode( $HTTP_RAW_POST_DATA ), 'URL Decoded Raw POST Request: ', __FILE__, __LINE__, __METHOD__, 0 );
|
||||
//Debug::writeToLog(); //Handled in TTShutdown now.
|
||||
exit;
|
||||
|
||||
}
|
||||
|
||||
if ( PRODUCTION == true && $argument_size > ( 1024 * 12 ) ) {
|
||||
Debug::Text( 'Arguments too large to display... Size: ' . $argument_size, __FILE__, __LINE__, __METHOD__, 10 );
|
||||
} else {
|
||||
if ( in_array( strtolower( $method ), [ 'login', 'changepassword', 'registerapikey', 'senderrorreport' ] ) && isset( $arguments[0] ) ) { //Make sure passwords arent displayed if logging is enabled.
|
||||
Debug::Arr( $arguments[0], '*Censored* Arguments: (Size: ' . $argument_size . ')', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
} else {
|
||||
Debug::Arr( $arguments, 'Arguments: (Size: ' . $argument_size . ')', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
}
|
||||
}
|
||||
unset( $argument_size );
|
||||
|
||||
$authentication = new Authentication();
|
||||
if ( isUnauthenticatedMethod( $method ) == true || $authentication->checkValidCSRFToken() == true ) { //Help prevent CSRF attacks with this, run this check during and before the user is logged in. However, when calling isLoggedIn() after being idle, if the CSRF/SessionID cookies are deleted, it will trigger a CSRF error before logging the user out. So we want to ignore CSRF checks for these functions.
|
||||
$session_id = getSessionID();
|
||||
if ( ( isset( $config_vars['other']['installer_enabled'] ) && $config_vars['other']['installer_enabled'] == false ) && ( !isset( $config_vars['other']['down_for_maintenance'] ) || isset( $config_vars['other']['down_for_maintenance'] ) && $config_vars['other']['down_for_maintenance'] == '' ) && $session_id != '' && !isset( $_GET['disable_db'] ) && isUnauthenticatedMethod( $method ) == false ) { //When interface calls PING() on a regular basis we need to skip this check and pass it to APIAuthentication immediately to avoid updating the session time.
|
||||
Debug::text( 'Session ID: ' . $session_id . ' Source IP: ' . Misc::getRemoteIPAddress(), __FILE__, __LINE__, __METHOD__, 10 );
|
||||
if ( $authentication->isSessionIDAPIKey( $session_id ) == true ) {
|
||||
$authentication_type_id = 700; //API Key
|
||||
} else if ( Misc::isMobileAppUserAgent() == true && Misc::getMobileAppClientVersion() != '' && version_compare( Misc::getMobileAppClientVersion(), '5.0.0', '<' ) ) { //As of Mobile App v5.0 it no longer uses Quick Punch ID/Password.
|
||||
$authentication_type_id = 605; //Phone ID - Mobile App
|
||||
} else {
|
||||
$authentication_type_id = [ 800, 810 ]; //USER_NAME, USER_NAME_MULTI_FACTOR
|
||||
}
|
||||
|
||||
if ( $class_name != 'APIProgressBar' && $authentication->Check( $session_id, $authentication_type_id ) === true ) { //Always treat APIProgressBar as unauthenticated as an optimization to avoid causing uncessary SQL queries.
|
||||
authenticatedInvokeService( $class_name, $method, $arguments, $message_id, $authentication, $api_auth );
|
||||
} else {
|
||||
Debug::text( 'SessionID set but user not authenticated!', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
//echo json_encode( $api_auth->returnHandler( FALSE, 'SESSION', TTi18n::getText('User is not authenticated.' ) ) );
|
||||
|
||||
//Rather than fail with session error, switch over to using unauthenticated calls, which if its calling to authenticated method will cause a SESSION error at that time.
|
||||
unauthenticatedInvokeService( $class_name, $method, $arguments, $message_id, $api_auth );
|
||||
}
|
||||
} else {
|
||||
Debug::text( 'No SessionID or calling non-authenticated function...', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
unauthenticatedInvokeService( $class_name, $method, $arguments, $message_id, $api_auth );
|
||||
}
|
||||
} else {
|
||||
echo json_encode( $api_auth->returnHandler( false, 'EXCEPTION_CSRF', TTi18n::getText( 'Invalid CSRF token, please refresh your browser and try again!' ) ) ); //Could potentially use a SESSION error so the front-end logs the user out so they can login again with a fresh CSRF token.
|
||||
}
|
||||
?>
|
||||
507
api/json/api_client_example.php
Normal file
507
api/json/api_client_example.php
Normal file
@ -0,0 +1,507 @@
|
||||
<?php
|
||||
require_once( '../../classes/modules/api/client/TimeTrexClientAPI.class.php' );
|
||||
|
||||
/*
|
||||
Global variables
|
||||
*/
|
||||
$TIMETREX_URL = 'https://demo.timetrex.com/next-release/api/json/api.php';
|
||||
$TIMETREX_API_KEY = ''; //API SESSION KEY to use for all API requests, obtained immediately below.
|
||||
if ( !isset( $TIMETREX_API_KEY ) || $TIMETREX_API_KEY == '' ) {
|
||||
//Register a API key for use with all subsequent API calls.
|
||||
$api_session = new TimeTrexClientAPI();
|
||||
$TIMETREX_API_KEY = $api_session->registerAPIKey( 'demoadmin1', 'demo' );
|
||||
if ( $TIMETREX_API_KEY == false ) {
|
||||
echo "Login Failed, please check username/password or URL to ensure it is correct!<br>\nIf multifactor authentication is enabled, login to TimeTrex and go to Profile -> Security / Passwords, More (...) -> Register API Key.<br>\n";
|
||||
exit;
|
||||
} else {
|
||||
echo "Permanent API KEY SESSION registered, you may now define this in your code for all subsequent API calls:<br>\n";
|
||||
echo "\$TIMETREX_API_KEY = '" . $TIMETREX_API_KEY . "'<br>\n";
|
||||
exit;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
//
|
||||
//Get data for two employees by user_name or primary key/ID.
|
||||
// - Many other filter methods can be used, such as branch, department, province, state, etc...
|
||||
//
|
||||
$user_obj = new TimeTrexClientAPI( 'User' );
|
||||
//$user_obj->setIdempotentKey( $user_obj->generateUUID() ); //Enable idempotent API call with a random UUID. Pass in FALSE to turn idempotency off.
|
||||
$result = $user_obj->getUser(
|
||||
[
|
||||
'filter_data' => [
|
||||
//'id' => [ '11e817cb-7dcc-7130-b939-5431e6810149','11e817cb-8385-8e50-97f3-5431e6810149' ],
|
||||
'user_name' => 'john.doe1',
|
||||
],
|
||||
]
|
||||
);
|
||||
|
||||
$user_data = $result->getResult();
|
||||
print $result;
|
||||
|
||||
/* //Example returned data:
|
||||
array(2) {
|
||||
[0]=>
|
||||
array(98) {
|
||||
["id"]=>
|
||||
string(36) "11e7fa4c-f3fd-2d90-b320-21ea65522ba3"
|
||||
["company_id"]=>
|
||||
string(36) "11e7fa4c-e7b5-37d0-87c6-21ea65522ba3"
|
||||
["company"]=>
|
||||
string(15) "ABC Company (1)"
|
||||
["legal_entity_id"]=>
|
||||
string(36) "11e7fa4c-e825-8050-8e4a-21ea65522ba3"
|
||||
["legal_name"]=>
|
||||
string(18) "ACME USA East Inc."
|
||||
["status_id"]=>
|
||||
string(2) "10"
|
||||
["status"]=>
|
||||
string(6) "Active"
|
||||
["group_id"]=>
|
||||
string(36) "11e7fa4c-e980-6090-adff-21ea65522ba3"
|
||||
["user_group"]=>
|
||||
string(9) "Corporate"
|
||||
["ethnic_group_id"]=>
|
||||
string(36) "11e7fa4c-e9a8-2880-9b0d-21ea65522ba3"
|
||||
["ethnic_group"]=>
|
||||
string(5) "White"
|
||||
["user_name"]=>
|
||||
string(14) "tristen.braun1"
|
||||
["phone_id"]=>
|
||||
string(0) ""
|
||||
["employee_number"]=>
|
||||
int(13)
|
||||
["title_id"]=>
|
||||
string(36) "11e7fa4c-e98e-4fb0-8cc1-21ea65522ba3"
|
||||
["title"]=>
|
||||
string(9) "Carpenter"
|
||||
["default_branch_id"]=>
|
||||
string(36) "11e7fa4c-e857-84b0-9ebc-21ea65522ba3"
|
||||
["default_branch"]=>
|
||||
string(8) "New York"
|
||||
["default_branch_manual_id"]=>
|
||||
string(1) "1"
|
||||
["default_department_id"]=>
|
||||
string(36) "11e7fa4c-e870-7660-b2a1-21ea65522ba3"
|
||||
["default_department"]=>
|
||||
string(12) "Construction"
|
||||
["default_department_manual_id"]=>
|
||||
string(1) "2"
|
||||
["default_job_id"]=>
|
||||
string(36) "00000000-0000-0000-0000-000000000000"
|
||||
["default_job"]=>
|
||||
bool(false)
|
||||
["default_job_manual_id"]=>
|
||||
bool(false)
|
||||
["default_job_item_id"]=>
|
||||
string(36) "00000000-0000-0000-0000-000000000000"
|
||||
["default_job_item"]=>
|
||||
bool(false)
|
||||
["default_job_item_manual_id"]=>
|
||||
bool(false)
|
||||
["permission_control_id"]=>
|
||||
string(36) "11e7fa4c-e7bb-a9b0-a40e-21ea65522ba3"
|
||||
["permission_control"]=>
|
||||
string(31) "Regular Employee (Punch In/Out)"
|
||||
["pay_period_schedule_id"]=>
|
||||
string(36) "11e7fa4d-0208-8360-a212-21ea65522ba3"
|
||||
["pay_period_schedule"]=>
|
||||
string(9) "Bi-Weekly"
|
||||
["policy_group_id"]=>
|
||||
string(36) "11e7fa4d-025e-93e0-bc8b-21ea65522ba3"
|
||||
["policy_group"]=>
|
||||
string(7) "Default"
|
||||
["first_name"]=>
|
||||
string(7) "Tristen"
|
||||
["first_name_metaphone"]=>
|
||||
string(5) "TRSTN"
|
||||
["middle_name"]=>
|
||||
bool(false)
|
||||
["last_name"]=>
|
||||
string(6) "BraunD"
|
||||
["last_name_metaphone"]=>
|
||||
string(4) "BRNT"
|
||||
["full_name"]=>
|
||||
string(15) "BraunD, Tristen"
|
||||
["second_last_name"]=>
|
||||
bool(false)
|
||||
["sex_id"]=>
|
||||
string(2) "20"
|
||||
["sex"]=>
|
||||
string(6) "Female"
|
||||
["address1"]=>
|
||||
string(13) "9289 Ethel St"
|
||||
["address2"]=>
|
||||
string(9) "Unit #560"
|
||||
["city"]=>
|
||||
string(8) "New York"
|
||||
["country"]=>
|
||||
string(2) "US"
|
||||
["province"]=>
|
||||
string(2) "NY"
|
||||
["postal_code"]=>
|
||||
string(5) "00521"
|
||||
["work_phone"]=>
|
||||
string(12) "417-268-2473"
|
||||
["work_phone_ext"]=>
|
||||
string(3) "204"
|
||||
["home_phone"]=>
|
||||
string(12) "567-570-8135"
|
||||
["mobile_phone"]=>
|
||||
bool(false)
|
||||
["fax_phone"]=>
|
||||
bool(false)
|
||||
["home_email"]=>
|
||||
bool(false)
|
||||
["home_email_is_valid"]=>
|
||||
bool(true)
|
||||
["home_email_is_valid_key"]=>
|
||||
bool(false)
|
||||
["home_email_is_valid_date"]=>
|
||||
bool(false)
|
||||
["feedback_rating"]=>
|
||||
bool(false)
|
||||
["work_email"]=>
|
||||
string(30) "tristen.braun1@abc-company.com"
|
||||
["work_email_is_valid"]=>
|
||||
bool(true)
|
||||
["work_email_is_valid_key"]=>
|
||||
bool(false)
|
||||
["work_email_is_valid_date"]=>
|
||||
bool(false)
|
||||
["birth_date"]=>
|
||||
string(9) "01-Jun-88"
|
||||
["birth_date_age"]=>
|
||||
int(29)
|
||||
["hire_date"]=>
|
||||
string(9) "26-May-13"
|
||||
["hire_date_age"]=>
|
||||
string(4) "4.74"
|
||||
["termination_date"]=>
|
||||
NULL
|
||||
["currency_id"]=>
|
||||
string(36) "11e7fa4c-e80b-8110-97b4-21ea65522ba3"
|
||||
["currency"]=>
|
||||
string(9) "US Dollar"
|
||||
["currency_rate"]=>
|
||||
string(12) "1.0000000000"
|
||||
["sin"]=>
|
||||
string(9) "401240815"
|
||||
["note"]=>
|
||||
bool(false)
|
||||
["longitude"]=>
|
||||
bool(false)
|
||||
["latitude"]=>
|
||||
bool(false)
|
||||
["tag"]=>
|
||||
string(0) ""
|
||||
["last_login_date"]=>
|
||||
NULL
|
||||
["max_punch_time_stamp"]=>
|
||||
NULL
|
||||
["deleted"]=>
|
||||
bool(false)
|
||||
["is_owner"]=>
|
||||
bool(false)
|
||||
["is_child"]=>
|
||||
bool(true)
|
||||
["created_by_id"]=>
|
||||
string(36) "11e7fa4c-e9e5-4bb0-90f9-21ea65522ba3"
|
||||
["created_by"]=>
|
||||
string(18) "Mr. AdministratorC"
|
||||
["created_date"]=>
|
||||
string(17) "15-Jan-18 3:36 PM"
|
||||
["updated_by_id"]=>
|
||||
string(36) "11e7fa4c-e9e5-4bb0-90f9-21ea65522ba3"
|
||||
["updated_by"]=>
|
||||
string(18) "Mr. AdministratorC"
|
||||
["updated_date"]=>
|
||||
string(17) "15-Feb-18 3:04 PM"
|
||||
}
|
||||
[1]=>
|
||||
array(98) {
|
||||
["id"]=>
|
||||
string(36) "11e7fa4c-f8c2-f040-8ad8-21ea65522ba3"
|
||||
["company_id"]=>
|
||||
string(36) "11e7fa4c-e7b5-37d0-87c6-21ea65522ba3"
|
||||
["company"]=>
|
||||
string(15) "ABC Company (1)"
|
||||
["legal_entity_id"]=>
|
||||
string(36) "11e7fa4c-e833-0860-9978-21ea65522ba3"
|
||||
["legal_name"]=>
|
||||
string(18) "ACME USA West Inc."
|
||||
["status_id"]=>
|
||||
string(2) "10"
|
||||
["status"]=>
|
||||
string(6) "Active"
|
||||
["group_id"]=>
|
||||
string(36) "11e7fa4c-e985-7df0-85ed-21ea65522ba3"
|
||||
["user_group"]=>
|
||||
string(15) "Human Resources"
|
||||
["ethnic_group_id"]=>
|
||||
string(36) "11e7fa4c-e9b2-5420-8bd5-21ea65522ba3"
|
||||
["ethnic_group"]=>
|
||||
string(6) "Indian"
|
||||
["user_name"]=>
|
||||
string(9) "jane.doe1"
|
||||
["phone_id"]=>
|
||||
string(5) "12341"
|
||||
["employee_number"]=>
|
||||
int(20)
|
||||
["title_id"]=>
|
||||
string(36) "11e7fa4c-e993-9320-8ba8-21ea65522ba3"
|
||||
["title"]=>
|
||||
string(15) "General Laborer"
|
||||
["default_branch_id"]=>
|
||||
string(36) "11e7fa4c-e85c-3ba0-b7aa-21ea65522ba3"
|
||||
["default_branch"]=>
|
||||
string(7) "Seattle"
|
||||
["default_branch_manual_id"]=>
|
||||
string(1) "2"
|
||||
["default_department_id"]=>
|
||||
string(36) "11e7fa4c-e870-7660-b2a1-21ea65522ba3"
|
||||
["default_department"]=>
|
||||
string(12) "Construction"
|
||||
["default_department_manual_id"]=>
|
||||
string(1) "2"
|
||||
["default_job_id"]=>
|
||||
string(36) "00000000-0000-0000-0000-000000000000"
|
||||
["default_job"]=>
|
||||
bool(false)
|
||||
["default_job_manual_id"]=>
|
||||
bool(false)
|
||||
["default_job_item_id"]=>
|
||||
string(36) "00000000-0000-0000-0000-000000000000"
|
||||
["default_job_item"]=>
|
||||
bool(false)
|
||||
["default_job_item_manual_id"]=>
|
||||
bool(false)
|
||||
["permission_control_id"]=>
|
||||
string(36) "11e7fa4c-e7bb-a9b0-a40e-21ea65522ba3"
|
||||
["permission_control"]=>
|
||||
string(31) "Regular Employee (Punch In/Out)"
|
||||
["pay_period_schedule_id"]=>
|
||||
string(36) "11e7fa4d-0208-8360-a212-21ea65522ba3"
|
||||
["pay_period_schedule"]=>
|
||||
string(9) "Bi-Weekly"
|
||||
["policy_group_id"]=>
|
||||
string(36) "11e7fa4d-025e-93e0-bc8b-21ea65522ba3"
|
||||
["policy_group"]=>
|
||||
string(7) "Default"
|
||||
["first_name"]=>
|
||||
string(4) "Jane"
|
||||
["first_name_metaphone"]=>
|
||||
string(2) "JN"
|
||||
["middle_name"]=>
|
||||
bool(false)
|
||||
["last_name"]=>
|
||||
string(3) "Doe"
|
||||
["last_name_metaphone"]=>
|
||||
string(1) "T"
|
||||
["full_name"]=>
|
||||
string(9) "Doe, Jane"
|
||||
["second_last_name"]=>
|
||||
bool(false)
|
||||
["sex_id"]=>
|
||||
string(2) "20"
|
||||
["sex"]=>
|
||||
string(6) "Female"
|
||||
["address1"]=>
|
||||
string(15) "4936 Ontario St"
|
||||
["address2"]=>
|
||||
string(9) "Unit #993"
|
||||
["city"]=>
|
||||
string(7) "Seattle"
|
||||
["country"]=>
|
||||
string(2) "US"
|
||||
["province"]=>
|
||||
string(2) "WA"
|
||||
["postal_code"]=>
|
||||
string(5) "98867"
|
||||
["work_phone"]=>
|
||||
string(12) "558-301-1737"
|
||||
["work_phone_ext"]=>
|
||||
string(3) "308"
|
||||
["home_phone"]=>
|
||||
string(12) "464-312-4450"
|
||||
["mobile_phone"]=>
|
||||
bool(false)
|
||||
["fax_phone"]=>
|
||||
bool(false)
|
||||
["home_email"]=>
|
||||
bool(false)
|
||||
["home_email_is_valid"]=>
|
||||
bool(true)
|
||||
["home_email_is_valid_key"]=>
|
||||
bool(false)
|
||||
["home_email_is_valid_date"]=>
|
||||
bool(false)
|
||||
["feedback_rating"]=>
|
||||
bool(false)
|
||||
["work_email"]=>
|
||||
string(25) "jane.doe1@abc-company.com"
|
||||
["work_email_is_valid"]=>
|
||||
bool(true)
|
||||
["work_email_is_valid_key"]=>
|
||||
bool(false)
|
||||
["work_email_is_valid_date"]=>
|
||||
bool(false)
|
||||
["birth_date"]=>
|
||||
string(9) "24-Dec-70"
|
||||
["birth_date_age"]=>
|
||||
int(47)
|
||||
["hire_date"]=>
|
||||
string(9) "15-Sep-09"
|
||||
["hire_date_age"]=>
|
||||
string(4) "8.44"
|
||||
["termination_date"]=>
|
||||
NULL
|
||||
["currency_id"]=>
|
||||
string(36) "11e7fa4c-e813-c120-9c2c-21ea65522ba3"
|
||||
["currency"]=>
|
||||
string(15) "Canadian Dollar"
|
||||