├── LICENSE ├── README.md ├── SoapZkClient.php ├── UdpZkClient.php └── ZkLib.php /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ZkLib PHP (SOAP AND UDP protocol) 2 | Communication between PHP language and ZK Time Attendance Devices (RFID, fingerprint, etc.). 3 | 4 | #About 5 | To interacts with ZK Time Attendance Devices with PHP.
6 | ZkLib use SOAP and UDP protocols.
7 | 8 | Some methods use the SOAP protocol:
9 | For example => add user, remove user, extraction of users log, etc.
10 |
11 | And some methods use the UDP protocol:
12 | For example => getDeviceName, getSerialNumber, free size, restart, unlock the door, etc.
13 |
14 | The implementation of the class UdpZkClient.php is the same implementation of this class in TADZKLib.php in this repositorie : tad-php
15 | Special thanks to Jorge Cobis !
16 | 17 | #Demo 18 | 19 | > $host = "0.0.0.0";
20 | > $zklib = new ZkLib($host);
21 | > $serial_number = $zklib->getSerialNumber();
22 | -------------------------------------------------------------------------------- /SoapZkClient.php: -------------------------------------------------------------------------------- 1 | filter_enable; 11 | } 12 | 13 | public function setFilter_enabled($filter_enabled) { 14 | $this->filter_enabled = $filter_enabled; 15 | } 16 | 17 | public function correctXml($data) { 18 | 19 | 20 | $allowChar = array("\r", "\n", " "); 21 | 22 | 23 | for ($i = 0; $i < strlen($data); $i++) { 24 | if ($data[$i] == ">") { 25 | for ($j = $i + 1; $j < strlen($data); $j++) { 26 | if (($data[$j] == "<" && $data[$j + 1] == "/") || ($data[$j] == "<" && ($data[$j - 1] == ">" || $data[$j - 1] == "\n"))) { 27 | break; 28 | } else if (!ctype_alnum($data[$j]) && !in_array($data[$j], $allowChar)) { 29 | $data[$j] = "*"; 30 | } 31 | } 32 | } 33 | } 34 | return $data; 35 | } 36 | 37 | public function __doRequest($req, $location, $action, $version = SOAP_1_1) { 38 | 39 | $original_response = (parent::__doRequest($req, $location, $action, $version)); 40 | if ($this->filter_enabled) { 41 | return str_replace("*", "", $this->correctXml($original_response)); 42 | } 43 | return $original_response; 44 | } 45 | 46 | } 47 | -------------------------------------------------------------------------------- /UdpZkClient.php: -------------------------------------------------------------------------------- 1 | [ 50 | 'command_id' => self::CMD_DEVICE, 51 | 'command_string' => '~Platform', 52 | 'should_disconnect' => true, 53 | 'result_filter_string' => '~Platform=' 54 | ], 55 | 'get_fingerprint_algorithm' => [ 56 | 'command_id' => self::CMD_DEVICE, 57 | 'command_string' => '~ZKFPVersion', 58 | 'should_disconnect' => true, 59 | 'result_filter_string' => '~ZKFPVersion=' 60 | ], 61 | 'get_serial_number' => [ 62 | 'command_id' => self::CMD_DEVICE, 63 | 'command_string' => '~SerialNumber', 64 | 'should_disconnect' => true, 65 | 'result_filter_string' => '~SerialNumber=' 66 | ], 67 | 'get_oem_vendor' => [ 68 | 'command_id' => self::CMD_DEVICE, 69 | 'command_string' => '~OEMVendor', 70 | 'should_disconnect' => true, 71 | 'result_filter_string' => '~OEMVendor=' 72 | ], 73 | 'get_mac_address' => [ 74 | 'command_id' => self::CMD_DEVICE, 75 | 'command_string' => 'MAC', 76 | 'should_disconnect' => true, 77 | 'result_filter_string' => 'MAC=' 78 | ], 79 | 'get_device_name' => [ 80 | 'command_id' => self::CMD_DEVICE, 81 | 'command_string' => '~DeviceName', 82 | 'should_disconnect' => true, 83 | 'result_filter_string' => '~DeviceName=' 84 | ], 85 | 'get_manufacture_time' => [ 86 | 'command_id' => self::CMD_DEVICE, 87 | 'command_string' => '~ProductTime', 88 | 'should_disconnect' => true, 89 | 'result_filter_string' => '~ProductTime=' 90 | ], 91 | 'get_anthostassback_mode' => [ 92 | 'command_id' => self::CMD_DEVICE, 93 | 'command_string' => '~APBFO', 94 | 'should_disconnect' => true, 95 | 'result_filter_string' => '~APBFO=' 96 | ], 97 | 'get_workcode' => [ 98 | 'command_id' => self::CMD_DEVICE, 99 | 'command_string' => '~WCFO', 100 | 'should_disconnect' => true, 101 | 'result_filter_string' => '~WCFO=' 102 | ], 103 | 'get_ext_format_mode' => [ 104 | 'command_id' => self::CMD_DEVICE, 105 | 'command_string' => '~ExtendFmt', 106 | 'should_disconnect' => true, 107 | 'result_filter_string' => '~ExtendFmt=' 108 | ], 109 | 'get_encrypted_mode' => [ 110 | 'command_id' => self::CMD_DEVICE, 111 | 'command_string' => 'encrypt_out', 112 | 'should_disconnect' => true, 113 | 'result_filter_string' => 'encrypt_out=' 114 | ], 115 | 'get_pin2_width' => [ 116 | 'command_id' => self::CMD_DEVICE, 117 | 'command_string' => '~PIN2Width', 118 | 'should_disconnect' => true, 119 | 'result_filter_string' => '~PIN2Width=' 120 | ], 121 | 'get_ssr_mode' => [ 122 | 'command_id' => self::CMD_DEVICE, 123 | 'command_string' => '~SSR', 124 | 'should_disconnect' => true, 125 | 'result_filter_string' => '~SSR=' 126 | ], 127 | 'get_firmware_version' => [ 128 | 'command_id' => self::CMD_VERSION, 129 | 'command_string' => self::EMPTY_STRING, 130 | 'should_disconnect' => true, 131 | 'result_filter_string' => false 132 | ], 133 | 'get_free_sizes' => [ 134 | 'command_id' => self::CMD_GET_FREE_SIZES, 135 | 'command_string' => self::EMPTY_STRING, 136 | 'should_disconnect' => true, 137 | 'result_filter_string' => false 138 | ], 139 | 'set_date' => [ 140 | 'command_id' => self::CMD_SET_TIME, 141 | 'command_string' => self::CUSTOMIZED_COMMAND_STRING, 142 | 'should_disconnect' => true, 143 | 'result_filter_string' => false 144 | ], 145 | 'delete_admin' => [ 146 | 'command_id' => self::CMD_CLEAR_ADMIN, 147 | 'command_string' => self::EMPTY_STRING, 148 | 'should_disconnect' => true, 149 | 'result_filter_string' => false 150 | ], 151 | 'enable' => [ 152 | 'command_id' => self::CMD_ENABLEDEVICE, 153 | 'command_string' => self::EMPTY_STRING, 154 | 'should_disconnect' => true, 155 | 'result_filter_string' => false 156 | ], 157 | 'disable' => [ 158 | 'command_id' => self::CMD_DISABLEDEVICE, 159 | 'command_string' => self::EMPTY_STRING, 160 | 'should_disconnect' => false, 161 | 'result_filter_string' => false 162 | ], 163 | 'restart' => [ 164 | 'command_id' => self::CMD_RESTART, 165 | 'command_string' => self::EMPTY_STRING, 166 | 'should_disconnect' => true, 167 | 'result_filter_string' => false 168 | ], 169 | 'unlock' => [ 170 | 'command_id' => self::CMD_UNLOCK, 171 | 'command_string' => self::EMPTY_STRING, 172 | 'should_disconnect' => true, 173 | 'result_filter_string' => false 174 | ], 175 | 'poweroff' => [ 176 | 'command_id' => self::CMD_POWEROFF, 177 | 'command_string' => self::EMPTY_STRING, 178 | 'should_disconnect' => true, 179 | 'result_filter_string' => false 180 | ], 181 | ]; 182 | 183 | public function setCommandOption($command_option) { 184 | $command = $command_option["command"]; 185 | $option_name = $command_option["option"]["name"]; 186 | $value_name = $command_option["option"]["value"]; 187 | $filter = $command_option["option"]["filter"]; 188 | $this->zklib_commands[$command][$option_name] = $value_name; 189 | $this->zklib_commands[$command]["result_filter_string"] = $filter; 190 | } 191 | 192 | public function __construct($option) { 193 | $this->host = $option["host"]; 194 | $this->port = $option["port"]; 195 | $this->encoding = $option["encoding"]; 196 | $this->client_socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP); 197 | $timeout = ['sec' => $option['connection_timeout'], 'usec' => 500000]; 198 | socket_set_option($this->client_socket, SOL_SOCKET, SO_RCVTIMEO, $timeout); 199 | } 200 | 201 | private function connect() { 202 | $command = self::CMD_CONNECT; 203 | $command_string = self::EMPTY_STRING; 204 | $chksum = 0; 205 | $session_id = 0; 206 | $reply_id = -1 + self::USHRT_MAX; 207 | 208 | $buf = $this->createHeader($command, $chksum, $session_id, $reply_id, $command_string); 209 | 210 | socket_sendto($this->client_socket, $buf, strlen($buf), 0, $this->host, $this->port); 211 | 212 | try { 213 | socket_recvfrom($this->client_socket, $this->data_recv, 1024, 0, $this->host, $this->port); 214 | if (strlen($this->data_recv) > 0) { 215 | $u = unpack('H2h1/H2h2/H2h3/H2h4/H2h5/H2h6', substr($this->data_recv, 0, 8)); 216 | 217 | $this->session_id = hexdec($u['h6'] . $u['h5']); 218 | return $this->checkValid($this->data_recv); 219 | } else { 220 | return false; 221 | } 222 | } catch (ErrorException $e) { 223 | return false; 224 | } catch (exception $e) { 225 | return false; 226 | } 227 | } 228 | 229 | private function disconnect() { 230 | $command = self::CMD_EXIT; 231 | $command_string = ''; 232 | $chksum = 0; 233 | $session_id = $this->session_id; 234 | 235 | $u = unpack('H2h1/H2h2/H2h3/H2h4/H2h5/H2h6/H2h7/H2h8', substr($this->data_recv, 0, 8)); 236 | $reply_id = hexdec($u['h8'] . $u['h7']); 237 | 238 | $buf = $this->createHeader($command, $chksum, $session_id, $reply_id, $command_string); 239 | 240 | socket_sendto($this->client_socket, $buf, strlen($buf), 0, $this->host, $this->port); 241 | try { 242 | socket_recvfrom($this->client_socket, $this->data_recv, 1024, 0, $this->host, $this->port); 243 | 244 | return $this->checkValid($this->data_recv); 245 | } catch (ErrorException $e) { 246 | return false; 247 | } catch (Exception $e) { 248 | return false; 249 | } 250 | } 251 | 252 | /** 253 | * Gets device's information about current device's storage. 254 | * 255 | * @return array device's storage information. 256 | */ 257 | public function zk_get_free_sizes() { 258 | $fs = []; 259 | $free_sizes_info = $this->reverse_hex(bin2hex($this->send_command_to_device(self::CMD_GET_FREE_SIZES))); 260 | 261 | if (!$free_sizes_info) { 262 | $fs = false; 263 | } else { 264 | if (self::DEVICE_GENERAL_INFO_STRING_LENGTH > strlen($free_sizes_info)) { 265 | $free_sizes_info = '000000000000000000000000' . $free_sizes_info; 266 | } 267 | 268 | $fs['att_logs_available'] = hexdec(substr($free_sizes_info, 27, 5)); 269 | $fs['templates_available'] = hexdec(substr($free_sizes_info, 44, 4)); 270 | $fs['att_logs_capacity'] = hexdec(substr($free_sizes_info, 51, 5)); 271 | $fs['templates_capacity'] = hexdec(substr($free_sizes_info, 60, 4)); 272 | $fs['passwords_stored'] = hexdec(substr($free_sizes_info, 76, 4)); 273 | $fs['admins_stored'] = hexdec(substr($free_sizes_info, 84, 4)); 274 | $fs['att_logs_stored'] = hexdec(substr($free_sizes_info, 116, 4)); 275 | $fs['templates_stored'] = hexdec(substr($free_sizes_info, 132, 4)); 276 | $fs['users_stored'] = hexdec(substr($free_sizes_info, 148, 4)); 277 | } 278 | 279 | return $fs; 280 | } 281 | 282 | /** 283 | * Helper that allows sending command to device. 284 | * 285 | * @param integer $command command code. 286 | * @param string $command_string subcommand. 287 | * @param int $reply_id device's reply. 288 | * @return boolean true on successfully, otherwise returns false. 289 | */ 290 | private function send_command_to_device($command, $command_string = '', $reply_id = null) { 291 | $chksum = 0; 292 | $session_id = $this->session_id; 293 | 294 | $u = unpack('H2h1/H2h2/H2h3/H2h4/H2h5/H2h6/H2h7/H2h8', substr($this->data_recv, 0, 8)); 295 | 296 | if (is_null($reply_id)) { 297 | $reply_id = hexdec($u['h8'] . $u['h7']); 298 | } 299 | 300 | $buf = $this->createHeader($command, $chksum, $session_id, $reply_id, $command_string); 301 | socket_sendto($this->client_socket, $buf, strlen($buf), 0, $this->host, $this->port); 302 | 303 | try { 304 | socket_recvfrom($this->client_socket, $this->data_recv, 1024, 0, $this->host, $this->port); 305 | $u = unpack('H2h1/H2h2/H2h3/H2h4/H2h5/H2h6', substr($this->data_recv, 0, 8)); 306 | $this->session_id = hexdec($u['h6'] . $u['h5']); 307 | 308 | $this->result = $this->checkValid($this->data_recv); 309 | 310 | return substr($this->data_recv, 8); 311 | } catch (ErrorException $e) { 312 | return false; 313 | } catch (exception $e) { 314 | return false; 315 | } 316 | } 317 | 318 | public function __call($command, array $args) { 319 | $should_disconnect = true; 320 | $args = count($args) === 0 ? [] : array_shift($args); 321 | $encoding = $this->encoding; 322 | //unset($this->encoding); 323 | 324 | $this->connect(); 325 | 326 | switch ($command) { 327 | case 'set_date': 328 | $response = $this->zk_set_date($args); 329 | break; 330 | 331 | case 'get_free_sizes': 332 | $response = $this->zk_get_free_sizes(); 333 | break; 334 | 335 | default: 336 | $should_disconnect = $this->zklib_commands[$command]['should_disconnect']; 337 | 338 | $response = $this->send_command_to_device( 339 | $this->zklib_commands[$command]['command_id'], $this->zklib_commands[$command]['command_string'] 340 | ); 341 | } 342 | 343 | $result_filter_string = $this->zklib_commands[$command]['result_filter_string']; 344 | $response = $this->build_command_response($command, $this->result, $response, $encoding, $result_filter_string); 345 | $should_disconnect && $this->disconnect(); 346 | return simplexml_load_string($response); 347 | //return new TADResponse($response, $encoding); 348 | } 349 | 350 | /** 351 | * Calculates the chksum of the packet to be sent to the device. 352 | * 353 | * @param string $p packed sent to the device. 354 | * @return string checksum calculated. 355 | */ 356 | private function createChkSum($p) { 357 | /* This function 358 | 359 | Copied from zkemsdk.c */ 360 | 361 | $l = count($p); 362 | $chksum = 0; 363 | $i = $l; 364 | $j = 1; 365 | while ($i > 1) { 366 | $u = unpack('S', pack('C2', $p['c' . $j], $p['c' . ($j + 1)])); 367 | 368 | $chksum += $u[1]; 369 | 370 | if ($chksum > self::USHRT_MAX) { 371 | $chksum -= self::USHRT_MAX; 372 | } 373 | 374 | $i-=2; 375 | $j+=2; 376 | } 377 | 378 | if ($i) { 379 | $chksum = $chksum + $p['c' . strval(count($p))]; 380 | } 381 | 382 | while ($chksum > self::USHRT_MAX) { 383 | $chksum -= self::USHRT_MAX; 384 | } 385 | 386 | if ($chksum > 0) { 387 | $chksum = -($chksum); 388 | } else { 389 | $chksum = abs($chksum); 390 | } 391 | 392 | $chksum -= 1; 393 | while ($chksum < 0) { 394 | $chksum += self::USHRT_MAX; 395 | } 396 | 397 | return pack('S', $chksum); 398 | } 399 | 400 | /** 401 | * Creates UDP header to be sent to the device. 402 | * 403 | * @param int $command command id. 404 | * @param string $chksum checksum associated. 405 | * @param int $session_id session id associated. 406 | * @param int $reply_id reply id associated. 407 | * @param string $command_string subcomand. 408 | * @return string UDP header. 409 | */ 410 | private function createHeader($command, $chksum, $session_id, $reply_id, $command_string) { 411 | /* This function puts a the parts that make up a packet together and 412 | packs them into a byte string */ 413 | $buf = pack('SSSS', $command, $chksum, $session_id, $reply_id) . $command_string; 414 | 415 | $buf = unpack('C' . (8 + strlen($command_string)) . 'c', $buf); 416 | 417 | $u = unpack('S', $this->createChkSum($buf)); 418 | 419 | if (is_array($u)) { 420 | while (list($key) = each($u)) { 421 | $u = $u[$key]; 422 | break; 423 | } 424 | } 425 | 426 | $chksum = $u; 427 | $reply_id += 1; 428 | 429 | if ($reply_id >= self::USHRT_MAX) { 430 | $reply_id -= self::USHRT_MAX; 431 | } 432 | 433 | $buf = pack('SSSS', $command, $chksum, $session_id, $reply_id); 434 | 435 | return $buf . $command_string; 436 | } 437 | 438 | /** 439 | * Checks a returned packet to see if it returned CMD_ACK_OK, indicating success. 440 | * 441 | * @param string $reply packet received from the device. 442 | * 443 | * @return boolean true on valid packet, otherwise returns false. 444 | */ 445 | private function checkValid($reply) { 446 | $u = unpack('H2h1/H2h2', substr($reply, 0, 8)); 447 | 448 | $command = hexdec($u['h2'] . $u['h1']); 449 | 450 | if ($command == self::CMD_ACK_OK) { 451 | return true; 452 | } else { 453 | return false; 454 | } 455 | } 456 | 457 | /** 458 | * Builds a command response with a XML format to keep TAD behavior. 459 | * 460 | * @param string $command command executed. 461 | * @param mixed $result command result. 462 | * @return string XML response. 463 | */ 464 | private function build_command_response($command, $result_code, $result, $encoding, $result_filter_string = false) { 465 | $response_data = []; 466 | 467 | $xml_tag = str_replace('_', ' ', $command); 468 | $base_xml_tag = join('', explode(' ', ucwords($xml_tag))) . 'Response'; 469 | 470 | if (is_array($result)) { 471 | if (0 === count($result)) { 472 | $xml_header = ''; 473 | $response = $xml_header . '<' . $base_xml_tag . '>' . ''; 474 | return $response; 475 | } 476 | $response_data = ['Row' => $result]; 477 | } else { 478 | if (!is_bool($result) && true === $result_code) { 479 | $result_filter_string = $result_filter_string ? $result_filter_string : null; 480 | 481 | $result_data = str_replace($result_filter_string, '', $result); 482 | } else { 483 | $result_data = ($result_code ? self::XML_SUCCESS_RESPONSE : self::XML_FAIL_RESPONSE); 484 | } 485 | 486 | $result_code = $result_code ? '1' : '0'; 487 | $response_data = ['Row' => ['Result' => $result_code, 'Information' => $result_data]]; 488 | } 489 | 490 | return $this->array_to_xml(new \SimpleXMLElement('<' . $base_xml_tag . '/>'), $response_data, $encoding); 491 | } 492 | 493 | /** 494 | * Take an array in the form of ['date'=>date_value, 'time'=>time_value] y returns 495 | * another array with the following form: 496 | * 497 | * 498 | * ['year'=>foo_year, 'month'=>bar_month, 'day'=>taz_day, 499 | * 'hour'=>foo_hour, 'minute=>bar_minute, 'second'=>taz_minute] 500 | * 501 | * 502 | * Any missing item from input array is replaced by corresponding element generated from 503 | * current date and time. 504 | * 505 | * @param array $dt input 'datetime' array. 506 | * @return array array generated. 507 | */ 508 | private function setup_datetime(array $dt = []) { 509 | $now = explode(' ', date("Y-m-d H:i:s")); 510 | $dt = array_filter($dt, 'strlen'); 511 | 512 | !isset($dt['date']) ? $dt['date'] = $now[0] : null; 513 | !isset($dt['time']) ? $dt['time'] = $now[1] : null; 514 | 515 | $date = explode('-', $dt['date']); 516 | $time = explode(':', $dt['time']); 517 | 518 | return [ 519 | 'year' => $date[0], 'month' => $date[1], 'day' => $date[2], 520 | 'hour' => $time[0], 'minute' => $time[1], 'second' => $time[2]]; 521 | } 522 | 523 | /** 524 | * Method taken from PHPLib @link http://dnaextrim.github.io/php_zklib/ project. 525 | * 526 | * @param string $hexstr hex string. 527 | * @return string hex string reversed. 528 | */ 529 | private function reverse_hex($hexstr) { 530 | $tmp = ''; 531 | 532 | for ($i = strlen($hexstr); $i >= 0; $i--) { 533 | $tmp .= substr($hexstr, $i, 2); 534 | $i--; 535 | } 536 | 537 | return $tmp; 538 | } 539 | 540 | /** 541 | * Method taken from PHPZKLib @link http://dnaextrim.github.io/php_zklib/ project. 542 | * 543 | * It's been modified to accept an associative array as input. 544 | * 545 | * @param array $t array with a timestamp data. 546 | * @return int timestamp encoded. 547 | */ 548 | private function encode_time(array $t) { 549 | /* Encode a timestamp send at the timeclock 550 | 551 | copied from zkemsdk.c - EncodeTime */ 552 | $d = ( ($t['year'] % 100) * 12 * 31 + (($t['month'] - 1) * 31) + $t['day'] - 1) * 553 | (24 * 60 * 60) + ($t['hour'] * 60 + $t['minute']) * 60 + $t['second']; 554 | 555 | return $d; 556 | } 557 | 558 | /** 559 | * Transforms an array into an XML string. 560 | * 561 | * @param \SimpleXMLElement $object SimpleXMLElement instance. 562 | * @param array $data input array to be transformed. 563 | * @return string XML string generated. 564 | */ 565 | private function array_to_xml(\SimpleXMLElement $object, array $data) { 566 | foreach ($data as $key => $value) { 567 | if (is_array($value)) { 568 | $new_object = $object->addChild($key); 569 | $this->array_to_xml($new_object, $value); 570 | } else { 571 | $object->addChild($key, $value); 572 | } 573 | } 574 | 575 | $xml = trim(str_replace("", '', $object->asXML())); 576 | 577 | return $xml; 578 | } 579 | 580 | } 581 | -------------------------------------------------------------------------------- /ZkLib.php: -------------------------------------------------------------------------------- 1 | "http://" . $host . "/iWsService", 23 | 'uri' => 'http://www.zksoftware/Service/message/', 24 | 'encoding' => 'UTF-8', 25 | 'exceptions' => false, 26 | 'trace' => true 27 | ]; 28 | 29 | $udp_option = [ 30 | 'connection_timeout' => 5, 31 | 'port' => 4370, 32 | 'host' => $host, 33 | 'encoding' => 'utf-8', 34 | ]; 35 | $this->soapClient = new SoapZkClient(null, $soap_options); 36 | $this->udpClient = new UdpZkClient($udp_option); 37 | } 38 | 39 | public function getDate() { 40 | $param = new \stdClass(); 41 | $param->ArgComKey = 0; 42 | $objectresult = $this->soapClient->GetDate($param); 43 | return($objectresult); 44 | } 45 | 46 | public function setDate($date, $time) { 47 | $param = new \stdClass(); 48 | $param->ArgComKey = 0; 49 | $param->Arg = new \stdClass(); 50 | $param->Arg->Date = $date; 51 | $param->Arg->Time = $time; 52 | $objectresult = $this->soapClient->SetDate($param); 53 | return($objectresult); 54 | } 55 | 56 | public function getUser($pin = null) { 57 | $this->soapClient->setFilter_enabled(true); 58 | $param = new \stdClass(); 59 | $param->ArgComKey = 0; 60 | $param->Arg = new \stdClass(); 61 | $param->Arg->PIN = $pin; 62 | $objectresult = $this->soapClient->GetUserInfo($param); 63 | $this->soapClient->setFilter_enabled(false); 64 | return($objectresult); 65 | } 66 | 67 | public function getAttLog($pin = null) { 68 | $param = new \stdClass(); 69 | $param->ArgComKey = 0; 70 | $param->Arg = new \stdClass(); 71 | $param->Arg->PIN = $pin; 72 | $objectresult = $this->soapClient->GetAttLog($param); 73 | return($objectresult); 74 | } 75 | 76 | public function setUser($user) { 77 | $this->deleteUser($user->PIN2); 78 | $param = new \stdClass(); 79 | $param->ArgComKey = 0; 80 | $param->Arg = new \stdClass(); 81 | $param->Arg->PIN2 = $user->PIN2; 82 | $param->Arg->Name = $user->Name; 83 | $param->Arg->Password = $user->Password; 84 | $param->Arg->Privilege = $user->Privilege; 85 | $param->Arg->Group = $user->Group; 86 | $param->Arg->Card = $user->Card; 87 | $param->Arg->TZ1 = $user->TZ1; 88 | $param->Arg->TZ2 = $user->TZ2; 89 | $param->Arg->TZ3 = $user->TZ3; 90 | $objectresult = $this->soapClient->SetUserInfo($param); 91 | $this->refreshDB(); 92 | return($objectresult); 93 | } 94 | 95 | 96 | public function deleteUser($pin) { 97 | $param = new \stdClass(); 98 | $param->ArgComKey = 0; 99 | $param->Arg = new \stdClass(); 100 | $param->Arg->PIN = $pin; 101 | $objectresult = $this->soapClient->DeleteUser($param); 102 | $this->refreshDB(); 103 | 104 | 105 | return($objectresult); 106 | } 107 | 108 | //value 109 | //1 : clear users 110 | //2 : clear user template 111 | //3 : clear attendance log 112 | public function clearData($value) { 113 | $param = new \stdClass(); 114 | $param->ArgComKey = 0; 115 | $param->Arg = new \stdClass(); 116 | $param->Arg->Value = $value; 117 | $objectresult = $this->soapClient->ClearData($param); 118 | return($objectresult); 119 | } 120 | 121 | public function refreshDB() { 122 | $param = new \stdClass(); 123 | $param->ArgComKey = 0; 124 | $this->soapClient->RefreshDB($param); 125 | } 126 | 127 | 128 | public function getOption() { 129 | $param = new \stdClass(); 130 | $param->ArgComKey = 0; 131 | $objectresult = $this->soapClient->GetOption($param); 132 | print_r($objectresult); 133 | } 134 | 135 | public function getDeviceName() { 136 | return($this->udpClient->get_device_name()); 137 | } 138 | 139 | public function getSerialNumber() { 140 | return($this->udpClient->get_serial_number()); 141 | } 142 | 143 | public function getFreeSize() { 144 | return($this->udpClient->get_free_sizes()); 145 | } 146 | 147 | public function disable() { 148 | return($this->udpClient->disable()); 149 | } 150 | 151 | public function restart() { 152 | return($this->udpClient->restart()); 153 | } 154 | 155 | public function unlock() { 156 | return($this->udpClient->unlock()); 157 | } 158 | 159 | public function enable() { 160 | return($this->udpClient->enable()); 161 | } 162 | 163 | } 164 | --------------------------------------------------------------------------------