├── .gitignore ├── COPYING ├── COPYING.LESSER ├── Dockerfile ├── README.md ├── cube_lib.php ├── db_schema.sql ├── screen.css ├── visualcube.php ├── visualcube_0.gif ├── visualcube_1.gif ├── visualcube_2.gif ├── visualcube_3.gif ├── visualcube_4.gif ├── visualcube_api.php ├── visualcube_config.php └── visualcube_dbprune.sh /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | .dropbox 3 | nbproject 4 | local 5 | 6 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | from php:7.4-apache 2 | 3 | RUN apt update 4 | RUN apt install --yes imagemagick 5 | 6 | COPY . /var/www/html/ 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VisualCube 2 | Generate custom Rubik's cube visualisations from your browser address bar. 3 | 4 | ### Installation Instructions 5 | 6 | These instructions are for installing the script on your own web server. If you do not have access to your own server, or would just like to try out the software, please visit: 7 | http://cube.rider.biz/visualcube.php 8 | 9 | #### Using Docker 10 | 11 | ``` 12 | docker build -t visualcube . 13 | docker run -p 80:80 --rm visualcube 14 | ``` 15 | 16 | ##### Prerequisites 17 | 18 | * Access to an Apache web server with PHP and ImageMagic installed. 19 | * A MySQL database. This is optional, but will improve performance if you have a high traffic website. 20 | 21 | ##### Steps 22 | 23 | 1. Download and extract the code into a web-accessible folder. 24 | 2. Edit the configuration variables in visualcube_config.php 25 | 3. Point your browser to: www.yourwebsite.com/visualcube.php 26 | 4. (Optional) Edit DB_USER, DB_PASS and DB_NAME in visualcube_dbprune.sh and install the cron job. 27 | 5. (Optional) Configure mod_rewrite to redirect image suffixes to corresponding fmt=xxx form. See below. 28 | 29 | ##### Configuring mod_rewrite 30 | Add a .htaccess file to the same folder as visualcube.php with something like the following: 31 | ``` 32 | RewriteEngine On 33 | 34 | RewriteCond %{HTTP_HOST} ^(www\.example\.com)$ 35 | RewriteRule ^visualcube\.(gif|png|jpg|jpeg|tiff|ico)$ http://www.example.com/visualcube.php?%{QUERY_STRING}&fmt=$1 [L] 36 | ``` 37 | 38 | 39 | ### Features 40 | 41 | * Fully 3D cube visualisation 42 | * Cube dimensions from 1x1x1 to NxNxN. Currently capped at 9x9 for performance. 43 | * Algorithm support 44 | * Complete orientation control 45 | * Multiple image formats 46 | * Custom image size 47 | * Cube and facelet transparency 48 | * Custom colour schemes and background 49 | * Image caching for speedy access 50 | * Cookie configurable variables 51 | * Arrow overlays 52 | * Highly configurable URL-based API 53 | * Open Source 54 | -------------------------------------------------------------------------------- /cube_lib.php: -------------------------------------------------------------------------------- 1 | . 22 | 23 | Copyright (C) 2010 Conrad Rider 24 | */ 25 | 26 | // Face constants 27 | global $U, $R, $F, $D, $L, $B; 28 | $U = 0; $R = 1; $F = 2; $D = 3; $L = 4; $B = 5; 29 | 30 | // Corner Constants 31 | global $URF, $UFL, $ULB, $UBR, $DFR, $DLF, $DBL, $DRB; 32 | $URF = 0; $UFL = 1; $ULB = 2; $UBR = 3; $DFR = 4; $DLF = 5; $DBL = 6; $DRB = 7; 33 | 34 | // Edge constants 35 | global $UR, $UF, $UL, $UB, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR; 36 | $UR = 0; $UF = 1; $UL = 2; $UB = 3; $DR = 4; $DF = 5; $DL = 6; $DB = 7; $FR = 8; $FL = 9; $BL = 10; $BR = 11; 37 | 38 | // Mapping from face constants to face letters 39 | global $FACE_NAMES; 40 | $FACE_NAMES = Array( 41 | $U => 'u', 42 | $R => 'r', 43 | $F => 'f', 44 | $D => 'd', 45 | $L => 'l', 46 | $B => 'b', 47 | ); 48 | 49 | // A solved cube 50 | global $SOLVED_CUBE; 51 | $SOLVED_CUBE = Array( 52 | Array( $U, $R, $F, $D, $L, $B ), 53 | Array( $URF, $UFL, $ULB, $UBR, $DFR, $DLF, $DBL, $DRB ), 54 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 55 | Array( $UR, $UF, $UL, $UB, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 56 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )); 57 | 58 | // Partial cubes used to verify the correct parts are solved 59 | global $VCUBE; 60 | $VCUBE = Array( 61 | // Verify a solved first layer 2x2 62 | '2FL' => Array( 63 | Array( -1, -1, -1, -1, -1, -1 ), 64 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 65 | Array( -1, -1, -1, -1, 0, 0, 0, 0 ), 66 | Array( -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ), 67 | Array( -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 )), 68 | // Verify an oriented first layer 2x2 69 | '2OFL' => Array( 70 | Array( -1, -1, -1, -1, -1, -1 ), 71 | Array( -1, -1, -1, -1, -1, -1, -1, -1), 72 | Array( -1, -1, -1, -1, 0, 0, 0, 0 ), 73 | Array( -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ), 74 | Array( -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 )), 75 | // Verify orientation is completely solved for 2x2 PBL 76 | '2O' => Array( 77 | Array( -1, -1, -1, -1, -1, -1 ), 78 | Array( -1, -1, -1, -1, -1, -1, -1, -1 ), 79 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 80 | Array( -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ), 81 | Array( -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 )), 82 | // Verify a solved F2L on 3x3 83 | 'F2L' => Array( 84 | Array( $U, $R, $F, $D, $L, $B ), 85 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 86 | Array( -1, -1, -1, -1, 0, 0, 0, 0 ), 87 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 88 | Array( -1, -1, -1, -1, 0, 0, 0, 0, 0, 0, 0, 0 )), 89 | // Verify a solved F2L and OCLL (for OCLL, COLL, ZBLL) 90 | 'F2L_OCLL' => Array( 91 | Array( $U, $R, $F, $D, $L, $B ), 92 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 93 | Array( -1, -1, -1, -1, 0, 0, 0, 0 ), 94 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 95 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 96 | // Verify a solved F2L and T OCLL (for T ZBLL) 97 | 'F2L_OCLL_T' => Array( 98 | Array( $U, $R, $F, $D, $L, $B ), 99 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 100 | Array( 0, 1, 2, 0, 0, 0, 0, 0 ), 101 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 102 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 103 | // Verify a solved F2L and U OCLL (for Headlights ZBLL) 104 | 'F2L_OCLL_U' => Array( 105 | Array( $U, $R, $F, $D, $L, $B ), 106 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 107 | Array( 0, 2, 1, 0, 0, 0, 0, 0 ), 108 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 109 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 110 | // Verify a solved F2L and L OCLL (for L ZBLL) 111 | 'F2L_OCLL_L' => Array( 112 | Array( $U, $R, $F, $D, $L, $B ), 113 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 114 | Array( 0, 2, 0, 1, 0, 0, 0, 0 ), 115 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 116 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 117 | // Verify a solved F2L and H OCLL (for H ZBLL) 118 | 'F2L_OCLL_H' => Array( 119 | Array( $U, $R, $F, $D, $L, $B ), 120 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 121 | Array( 2, 1, 2, 1, 0, 0, 0, 0 ), 122 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 123 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 124 | // Verify a solved F2L and PI OCLL (for PI ZBLL) 125 | 'F2L_OCLL_PI' => Array( 126 | Array( $U, $R, $F, $D, $L, $B ), 127 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 128 | Array( 1, 2, 2, 1, 0, 0, 0, 0 ), 129 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 130 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 131 | // Verify a solved F2L and Sune OCLL (for Sune ZBLL) 132 | 'F2L_OCLL_S' => Array( 133 | Array( $U, $R, $F, $D, $L, $B ), 134 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 135 | Array( 0, 2, 2, 2, 0, 0, 0, 0 ), 136 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 137 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 138 | // Verify a solved F2L and Anti-sune OCLL (for Anti-sune ZBLL) 139 | 'F2L_OCLL_AS' => Array( 140 | Array( $U, $R, $F, $D, $L, $B ), 141 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 142 | Array( 1, 0, 1, 1, 0, 0, 0, 0 ), 143 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 144 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 145 | // Verify a solved F2L and OLL (for PLL) 146 | 'F2L_OLL' => Array( 147 | Array( $U, $R, $F, $D, $L, $B ), 148 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 149 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 150 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 151 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 152 | // Verify a solved F2L and LL corners (for ELL) 153 | 'F2L_CLL' => Array( 154 | Array( $U, $R, $F, $D, $L, $B ), 155 | Array( $URF, $UFL, $ULB, $UBR, $DFR, $DLF, $DBL, $DRB ), 156 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 157 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 158 | Array( -1, -1, -1, -1, 0, 0, 0, 0, 0, 0, 0, 0 )), 159 | // Verify a solved F2B (for CMLL) 160 | 'F2B' => Array( 161 | Array( -1, $R, -1, -1, $L, -1 ), 162 | Array( -1, -1, -1, -1, $DFR, $DLF, $DBL, $DRB ), 163 | Array( -1, -1, -1, -1, 0, 0, 0, 0 ), 164 | Array( -1, -1, -1, -1, $DR, -1, $DL, -1, $FR, $FL, $BL, $BR ), 165 | Array( -1, -1, -1, -1, 0, -1, 0, -1, 0, 0, 0, 0 )), 166 | // Verify a solved F2L minus last slot (for ELS) 167 | 'F2LS' => Array( 168 | Array( $U, $R, $F, $D, $L, $B ), 169 | Array( -1, -1, -1, -1, -1, $DLF, $DBL, $DRB ), 170 | Array( -1, -1, -1, -1, -1, 0, 0, 0 ), 171 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, -1, $FL, $BL, $BR ), 172 | Array( -1, -1, -1, -1, 0, 0, 0, 0, -1, 0, 0, 0 )), 173 | // Verify a solved F2L, minus last slot, with EO and solved FR (for CLS) 174 | 'F2LS_EO' => Array( 175 | Array( $U, $R, $F, $D, $L, $B ), 176 | Array( -1, -1, -1, -1, -1, $DLF, $DBL, $DRB ), 177 | Array( -1, -1, -1, -1, -1, 0, 0, 0 ), 178 | Array( -1, -1, -1, -1, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 179 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )) 180 | ); 181 | 182 | // An array storing all cubie-level moves 183 | global $CUBIE_MOVES; 184 | $CUBIE_MOVES = Array( 185 | Array( // U 186 | Array( $U, $R, $F, $D, $L, $B ), 187 | Array( $UBR, $URF, $UFL, $ULB, $DFR, $DLF, $DBL, $DRB ), 188 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 189 | Array( $UB, $UR, $UF, $UL, $DR, $DF, $DL, $DB, $FR, $FL, $BL, $BR ), 190 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 191 | Array( // R 192 | Array( $U, $R, $F, $D, $L, $B ), 193 | Array( $DFR, $UFL, $ULB, $URF, $DRB, $DLF, $DBL, $UBR ), 194 | Array( 2, 0, 0, 1, 1, 0, 0, 2 ), 195 | Array( $FR, $UF, $UL, $UB, $BR, $DF, $DL, $DB, $DR, $FL, $BL, $UR ), 196 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 197 | Array( // F 198 | Array( $U, $R, $F, $D, $L, $B ), 199 | Array( $UFL, $DLF, $ULB, $UBR, $URF, $DFR, $DBL, $DRB ), 200 | Array( 1, 2, 0, 0, 2, 1, 0, 0 ), 201 | Array( $UR, $FL, $UL, $UB, $DR, $FR, $DL, $DB, $UF, $DF, $BL, $BR ), 202 | Array( 0, 1, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0 )), 203 | Array( // D 204 | Array( $U, $R, $F, $D, $L, $B ), 205 | Array( $URF, $UFL, $ULB, $UBR, $DLF, $DBL, $DRB, $DFR ), 206 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 207 | Array( $UR, $UF, $UL, $UB, $DF, $DL, $DB, $DR, $FR, $FL, $BL, $BR ), 208 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 209 | Array( // L 210 | Array( $U, $R, $F, $D, $L, $B ), 211 | Array( $URF, $ULB, $DBL, $UBR, $DFR, $UFL, $DLF, $DRB ), 212 | Array( 0, 1, 2, 0, 0, 2, 1, 0 ), 213 | Array( $UR, $UF, $BL, $UB, $DR, $DF, $FL, $DB, $FR, $UL, $DL, $BR ), 214 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 )), 215 | Array( // B 216 | Array( $U, $R, $F, $D, $L, $B ), 217 | Array( $URF, $UFL, $UBR, $DRB, $DFR, $DLF, $ULB, $DBL ), 218 | Array( 0, 0, 1, 2, 0, 0, 2, 1 ), 219 | Array( $UR, $UF, $UL, $BR, $DR, $DF, $DL, $BL, $FR, $FL, $UB, $DB ), 220 | Array( 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 1, 1 )), 221 | Array( // E 222 | Array( $U, $F, $L, $D, $B, $R ), 223 | Array( $URF, $UFL, $ULB, $UBR, $DFR, $DLF, $DBL, $DRB ), 224 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 225 | Array( $UR, $UF, $UL, $UB, $DR, $DF, $DL, $DB, $FL, $BL, $BR, $FR ), 226 | Array( 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1 )), 227 | Array( // M 228 | Array( $B, $R, $U, $F, $L, $D ), 229 | Array( $URF, $UFL, $ULB, $UBR, $DFR, $DLF, $DBL, $DRB ), 230 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 231 | Array( $UR, $UB, $UL, $DB, $DR, $UF, $DL, $DF, $FR, $FL, $BL, $BR ), 232 | Array( 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 0, 0 )), 233 | Array( // S 234 | Array( $L, $U, $F, $R, $D, $B ), 235 | Array( $URF, $UFL, $ULB, $UBR, $DFR, $DLF, $DBL, $DRB ), 236 | Array( 0, 0, 0, 0, 0, 0, 0, 0 ), 237 | Array( $UL, $UF, $DL, $UB, $UR, $DF, $DR, $DB, $FR, $FL, $BL, $BR ), 238 | Array( 1, 0, 1, 0, 1, 0, 1, 0, 0, 0, 0, 0 ))); 239 | 240 | // Now that the elementry moves are defined, the rest of the moves can be built 241 | $CUBIE_MOVES = Array( 242 | $CUBIE_MOVES[0], 243 | $CUBIE_MOVES[1], 244 | $CUBIE_MOVES[2], 245 | $CUBIE_MOVES[3], 246 | $CUBIE_MOVES[4], 247 | $CUBIE_MOVES[5], 248 | prod(array_copy($CUBIE_MOVES[0]), $CUBIE_MOVES[6], 3), 249 | prod(array_copy($CUBIE_MOVES[1]), $CUBIE_MOVES[7], 3), 250 | prod(array_copy($CUBIE_MOVES[2]), $CUBIE_MOVES[8], 1), 251 | prod(array_copy($CUBIE_MOVES[3]), $CUBIE_MOVES[6], 1), 252 | prod(array_copy($CUBIE_MOVES[4]), $CUBIE_MOVES[7], 1), 253 | prod(array_copy($CUBIE_MOVES[5]), $CUBIE_MOVES[8], 3), 254 | $CUBIE_MOVES[6], 255 | $CUBIE_MOVES[7], 256 | $CUBIE_MOVES[8], 257 | prod(prod(array_copy($CUBIE_MOVES[0]), $CUBIE_MOVES[3], 3), $CUBIE_MOVES[6], 3), 258 | prod(prod(array_copy($CUBIE_MOVES[1]), $CUBIE_MOVES[4], 3), $CUBIE_MOVES[7], 3), 259 | prod(prod(array_copy($CUBIE_MOVES[2]), $CUBIE_MOVES[5], 3), $CUBIE_MOVES[8], 1)); 260 | 261 | // Mapping from power to chr to represent it 262 | global $ALG_POW; 263 | $ALG_POW = Array ('', "2", "'"); 264 | 265 | // Returns the case identified by this alg (or -1 if not belonging to group), 266 | // as well an amended alg with any rotations required to make it fit the group 267 | function gen_state($moves, $puzzle, $group_id, $is_ll){ 268 | global $SOLVED_CUBE, $CUBIE_MOVES, $VCUBE; 269 | 270 | //println("\nGENSTATE:\ninput moves=$moves"); 271 | $moves = trim_rotations($moves, $is_ll); 272 | 273 | //println("trimmed moves=$moves"); 274 | 275 | // 1. Apply different combinations of initial 276 | // and final moves until a solved state is found 277 | $prtns = Array("", "x", "x'", "x2", "z", "z'", "y", "y'"); 278 | $frtns = Array("", "x", "x'", "x2", "z", "z'", "y", "y'"); 279 | $valid = false; 280 | for($i = 0; $i < count($frtns) && !$valid; $i++){ 281 | for($j = 0; $j < count($prtns) && !$valid; $j++){ 282 | $cube = case_cube($prtns[$j].$moves.$frtns[$i]); 283 | //println("testing cube: ".$prtns[$j].$moves.$frtns[$i]); 284 | //printcube($cube, 3); 285 | if(is_member($cube, $group_id)){ 286 | $prtn = $prtns[$j]; 287 | $frtn = $frtns[$i]; 288 | $moves = "$prtn$moves$frtn"; 289 | $valid = true; 290 | } 291 | } 292 | } 293 | // Stop here if alg not valid 294 | if(!$valid) return Array(-1, $moves); 295 | 296 | //println("corrected moves=$prtn$moves$frtn"); 297 | 298 | // 2. Find angle to apply alg which results in lowest state id 299 | // This is necessery to ensure all rotations of same alg are given same state 300 | // Generate 4 case cubes 301 | $cubes = case_cubes2($moves, Array("", "y", "y2", "y'")); 302 | $state = PHP_INT_MAX; 303 | foreach($cubes as $cube){ 304 | //printcube($cube, 3); 305 | // Check cube from all y rotation angles 306 | for($i = 0; $i < 4; $i++){ 307 | // Generate identifier for state (depends on alg purpose) 308 | $s = cube_state($cube, $group_id); 309 | //println($s); 310 | // Set it as main ID if lowest found so-far 311 | if($s < $state && $s != -1) $state = $s; 312 | // Rotate cube by y 313 | $cube = prod($cube, $CUBIE_MOVES[move_id('y')], 1); 314 | } 315 | } 316 | //println("detected state=$state"); 317 | // Return cube state and moves which make cube state valid 318 | return Array($state, $prtn, $frtn); 319 | } 320 | // Rotate input alg to match reference alg's orientation and output corrected alg 321 | function orient_alg($alg, $ref, $puzzle, $group_id){ 322 | global $SOLVED_CUBE, $CUBIE_MOVES, $ALG_POW; 323 | // Remove initial y rotations from alg 324 | $alg = preg_replace('/^y[2\']?/', '', $alg); 325 | $cubes = case_cubes2($alg, Array("", "y", "y2", "y'")); 326 | $ref_cube = case_cube($ref); 327 | //print_r2($ref_cube[1]); 328 | //print_r2($ref_cube[3]); 329 | 330 | $match = false; 331 | foreach($cubes as $cube){ 332 | // Now apply up to 3 y twists until the case matches 333 | $r = 0; 334 | while(!$match && $r < 4){ 335 | // Detection of identical case (inc cube oriented correctly) 336 | // For OLL all LL orientations should match 337 | switch($group_id){ 338 | case 1: // OLL 339 | $match = cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)); // CO 340 | break; 341 | case 2: // PBL (permutation of all corners) 342 | $match = cube_match($cube[1], $ref_cube[1]); // CP 343 | break; 344 | case 3: // CLL (LL orientation + permutation) 345 | $match = cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 346 | && cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)); // CP 347 | break; 348 | case 4: // OLL 349 | $match = cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 350 | && cube_match(array_slice($cube[4], 0, 4), array_slice($ref_cube[4], 0, 4)); // EO 351 | break; 352 | case 5: // PLL 353 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 354 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 355 | break; 356 | case 6: // CLL 357 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 358 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)); // CO 359 | break; 360 | case 7: // ELL 361 | $match = cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)) // EP 362 | && cube_match(array_slice($cube[4], 0, 4), array_slice($ref_cube[4], 0, 4)); // EO 363 | break; 364 | case 8: // CMLL 365 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 366 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)); // CO 367 | break; 368 | case 9: // COLL 369 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 370 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)); // CO 371 | break; 372 | case 10: // ZBLL 373 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 374 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 375 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 376 | break; 377 | case 11: // ELS 378 | $match = cube_match(array_slice($cube[4], 0, 4), array_slice($ref_cube[4], 0, 4)) // EO 379 | && els_FR($cube) == els_FR($ref_cube); 380 | break; 381 | case 12: // CLS 382 | cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)); // CO 383 | break; 384 | case 13: // ZBLL-T 385 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 386 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 387 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 388 | break; 389 | case 14: // ZBLL-U 390 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 391 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 392 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 393 | break; 394 | case 15: // ZBLL-L 395 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 396 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 397 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 398 | break; 399 | case 16: // ZBLL-H 400 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 401 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 402 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 403 | break; 404 | case 17: // ZBLL-Pi 405 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 406 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 407 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 408 | break; 409 | case 18: // ZBLL-S 410 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 411 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 412 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 413 | break; 414 | case 19: // ZBLL-As 415 | $match = cube_match(array_slice($cube[1], 0, 4), array_slice($ref_cube[1], 0, 4)) // CP 416 | && cube_match(array_slice($cube[2], 0, 4), array_slice($ref_cube[2], 0, 4)) // CO 417 | && cube_match(array_slice($cube[3], 0, 4), array_slice($ref_cube[3], 0, 4)); // EP 418 | break; 419 | } 420 | //if($match) println("r:$r true"); 421 | //else println("r:$r false"); 422 | //print_r2($cube[1]); 423 | //print_r2($cube[3]); 424 | // If no match found rotate cube and incrament rotation counter 425 | if(!$match){ 426 | $cube = prod($cube, $CUBIE_MOVES[move_id('y')], 1); 427 | $r++; 428 | } 429 | } 430 | if($match) break; 431 | } 432 | // Rotation required is the inverse of rotations used to match case 433 | if($r > 0) $alg = "y".$ALG_POW[3 - $r].$alg; 434 | return $alg; 435 | } 436 | // Returns the location of the FR edge for ELS 437 | function els_FR($cube){ 438 | global $FR; 439 | $frp = 0; // assuming its in position 440 | for($j = 0; $j < 4; $j++){ if($cube[3][$j] == $FR){ $frp = $i + 1; break; }} 441 | return $frp; 442 | } 443 | 444 | // TODO: This function failes on alg... x' U' R U L' U2 R' U' L' U' L2 u r2 U' z ... part of ZBLL-PI, or H 445 | // U' l2 u R2 U' R' U' L' U2 R' U L U' ... from ZBLL-PI 446 | // Returns true if the cube state is a member of the given group 447 | function is_member($cube, $group_id){ 448 | //echo "is member of? $group_id :"; 449 | //printcube($cube, 3); 450 | global $CUBIE_MOVES; 451 | // Check cube from all y rotation angles 452 | for($i = 0; $i < 4; $i++){ 453 | //println("|".$cube[2][0].", ".$cube[2][1].", ".$cube[2][2].", ".$cube[2][3]."|"); 454 | //printcube($cube, 3); 455 | for($j = 0; $j < 4; $j++){ 456 | if(is_member_strict($cube, $group_id)) return true; 457 | // Rotate cube 458 | $cube = prod($cube, $CUBIE_MOVES[move_id('y')], 1); 459 | } 460 | // Rotate U-Layer 461 | $cube = prod($cube, $CUBIE_MOVES[move_id('U')], 1); 462 | } 463 | return false; 464 | } 465 | 466 | // Returns true if the cube state is a member of the given group when AUF is allowed 467 | function is_member_auf($cube, $group_id){ 468 | //echo "is member of? $group_id :"; 469 | //printcube($cube, 3); 470 | global $CUBIE_MOVES; 471 | // Check cube from all auf rotation angles 472 | for($i = 0; $i < 4; $i++){ 473 | //println("|".$cube[2][0].", ".$cube[2][1].", ".$cube[2][2].", ".$cube[2][3]."|"); 474 | //printcube($cube, 3); 475 | if(is_member_strict($cube, $group_id)) return true; 476 | // Rotate U-Layer 477 | $cube = prod($cube, $CUBIE_MOVES[move_id('U')], 1); 478 | } 479 | return false; 480 | } 481 | 482 | function is_member_strict($cube, $group_id){ 483 | global $VCUBE; 484 | switch($group_id){ 485 | case 1: if(cube_match($cube, $VCUBE['2OFL'] )) return true; break; // OLL 486 | case 2: if(cube_match($cube, $VCUBE['2O'] )) return true; break; // PBL 487 | case 3: if(cube_match($cube, $VCUBE['2FL'] )) return true; break; // CLL 488 | case 4: if(cube_match($cube, $VCUBE['F2L'] )) return true; break; // OLL 489 | case 5: if(cube_match($cube, $VCUBE['F2L_OLL'] )) return true; break; // PLL 490 | case 6: if(cube_match($cube, $VCUBE['F2L'] )) return true; break; // CLL 491 | case 7: if(cube_match($cube, $VCUBE['F2L_CLL'] )) return true; break; // ELL 492 | case 8: if(cube_match($cube, $VCUBE['F2B'] )) return true; break; // CMLL 493 | case 9: if(cube_match($cube, $VCUBE['F2L_OCLL'])) return true; break; // COLL 494 | case 10: if(cube_match($cube, $VCUBE['F2L_OCLL'])) return true; break; // ZBLL 495 | case 11: if(cube_match($cube, $VCUBE['F2LS'] )) return true; break; // ELS 496 | case 12: if(cube_match($cube, $VCUBE['F2LS_EO'] )) return true; break; // CLS 497 | case 13: if(cube_match($cube, $VCUBE['F2L_OCLL_T'])) return true; break; // ZBLL-T 498 | case 14: if(cube_match($cube, $VCUBE['F2L_OCLL_U'])) return true; break; // ZBLL-U 499 | case 15: if(cube_match($cube, $VCUBE['F2L_OCLL_L'])) return true; break; // ZBLL-L 500 | case 16: if(cube_match($cube, $VCUBE['F2L_OCLL_H'])) return true; break; // ZBLL-H 501 | case 17: if(cube_match($cube, $VCUBE['F2L_OCLL_PI'])) return true; break; // ZBLL-PI 502 | case 18: if(cube_match($cube, $VCUBE['F2L_OCLL_S'])) return true; break; // ZBLL-S 503 | case 19: if(cube_match($cube, $VCUBE['F2L_OCLL_AS'])) return true; break; // ZBLL-AS 504 | } 505 | return false; 506 | } 507 | 508 | // Returns a value uniquely identifying this cube state in this group 509 | function cube_state($cube, $group_id){ 510 | switch($group_id){ 511 | case 1: return encode_o(array_slice($cube[2], 0, 3), 3); // CO (2x2 OLL) 512 | case 2: return encode_p($cube[1]); // CP (all corners) (PBL) 513 | case 3: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (2x2 CLL) 514 | + encode_p(array_slice($cube[1], 0, 4)) * 27; // CP 515 | case 4: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (OLL) 516 | + encode_o(array_slice($cube[4], 0, 3), 2) * 27; // EO (* 3^3) 517 | case 5: return encode_p(array_slice($cube[1], 0, 4), 3) // CP (PLL) 518 | + encode_p(array_slice($cube[3], 0, 4)) * 24; // EO (* 4!) 519 | case 6: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (CLL) 520 | + encode_p(array_slice($cube[1], 0, 4)) * 27; // CP 521 | case 7: return encode_o(array_slice($cube[4], 0, 3), 2) // EO (ELL) 522 | + encode_p(array_slice($cube[3], 0, 4)) * 8; // EP 523 | case 8: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (CMLL) 524 | + encode_p(array_slice($cube[1], 0, 4)) * 27; // CP 525 | case 9: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (COLL) 526 | + encode_p(array_slice($cube[1], 0, 4)) * 27; // CP 527 | case 10: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL) 528 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 529 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 530 | case 11: // ELS 531 | // This must encode orientation of the 4 top edges (fifth is determined by other 4) 532 | // along with the position of the FR edge 533 | return encode_o(array_slice($cube[4], 0, 4), 2) 534 | + els_FR($cube) * 16; // EO(5 edges) + position of FR 535 | case 12: // CLS must track the orientation of the 5 corners (determined by o of 4 top ones) 536 | return encode_o(array_slice($cube[2], 0, 4), 3); // CO 537 | case 13: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-T) 538 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 539 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 540 | case 14: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-U) 541 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 542 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 543 | case 15: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-L) 544 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 545 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 546 | case 16: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-Pi) 547 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 548 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 549 | case 17: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-H) 550 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 551 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 552 | case 18: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-S) 553 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 554 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 555 | case 19: return encode_o(array_slice($cube[2], 0, 3), 3) // CO (ZBLL-AS) 556 | + encode_p(array_slice($cube[1], 0, 4)) * 27 // CP 557 | + encode_p(array_slice($cube[3], 0, 4)) * 27 * 24; // EP 558 | } 559 | return -1; 560 | } 561 | // Returs the cube-state the given alg solves 562 | function case_cube($alg){ 563 | global $SOLVED_CUBE, $F2L_CUBE, $CUBIE_MOVES; 564 | // Apply inverse to get state which alg solves 565 | $alg = invert_alg($alg); 566 | $cube = array_copy($SOLVED_CUBE); 567 | return apply_alg($alg, $cube); 568 | } 569 | // Returns a set of case cubes representing the state of the 570 | // cube the alg solves, given the rotation was applied first 571 | function case_cubes($alg, $prerot){ 572 | global $SOLVED_CUBE; 573 | // Apply inverse to get state which alg solves 574 | $alg = invert_alg($alg); 575 | foreach($prerot as $i => $rtn){ 576 | $cubes[$i] = apply_alg($alg.invert_alg($rtn), array_copy($SOLVED_CUBE)); 577 | } 578 | return $cubes; 579 | } 580 | // Returns a set of case cubes representing the state of the 581 | // cube the alg solves, given the rotation was applied last 582 | function case_cubes2($alg, $postrot){ 583 | global $SOLVED_CUBE; 584 | // Apply inverse to get state which alg solves 585 | $alg = invert_alg($alg); 586 | foreach($postrot as $i => $rtn){ 587 | $cubes[$i] = apply_alg(invert_alg($rtn).$alg, array_copy($SOLVED_CUBE)); 588 | } 589 | return $cubes; 590 | } 591 | // Returns the move required to rotate the cube to an upright position 592 | function upright($cube){ 593 | global $U, $R, $F, $D, $L, $B, $CUBIE_MOVES; 594 | // search for U face centre 595 | $upos = 0; 596 | foreach($cube[0] as $i => $c){ 597 | if($c == $U){ 598 | $upos = $i; 599 | break; 600 | } 601 | } 602 | $move = ""; 603 | switch($upos){ 604 | case $R : $move = "z'"; break; 605 | case $L : $move = "z"; break; 606 | case $F : $move = "x"; break; 607 | case $B : $move = "x'"; break; 608 | case $D : $move = "x2"; break; 609 | } 610 | return $move; 611 | } 612 | 613 | // Convert cubie cube to face cube, using the default facelet identifiers 614 | function face_cube($cube, $dim){ 615 | // Construct default facelet id scheme 616 | for($f = 0; $f < 6; $f++){ 617 | for($i = 0; $i < $dim; $i++){ 618 | for($j = 0; $j < $dim; $j++) $fd .= $f; 619 | } 620 | } 621 | return facelet_cube($cube, $dim, $fd); 622 | } 623 | 624 | 625 | // Convert cubie cube to facelet cube mapping each facelet 626 | // to the given facelet id sequence 627 | function facelet_cube($cube, $d, $fi){ 628 | global $U, $R, $F, $D, $L, $B; 629 | // Facelet constants 630 | 631 | // Dimension/2 632 | $h = (int)($d/2); 633 | // Dimension squared 634 | $s = $d * $d; 635 | // Half of dimension squared 636 | $m = (int)($s/2); 637 | 638 | // Map centre positions to facelet ids 639 | $mfid = Array($fi[$U*$s+$m], $fi[$R*$s+$m], $fi[$F*$s+$m], $fi[$D*$s+$m], $fi[$L*$s+$m], $fi[$B*$s+$m]); 640 | 641 | // Map the corner positions to facelet ids 642 | $cfid = Array( 643 | Array($fi[ ($U+1)*$s-1], $fi[ $R*$s], $fi[ $F*$s+$d-1]), 644 | Array($fi[($U+1)*$s-$d], $fi[ $F*$s], $fi[ $L*$s+$d-1]), 645 | Array($fi[ $U*$s], $fi[ $L*$s], $fi[ $B*$s+$d-1]), 646 | Array($fi[ $U*$s+$d-1], $fi[ $B*$s], $fi[ $R*$s+$d-1]), 647 | Array($fi[ $D*$s+$d-1], $fi[($F+1)*$s-1], $fi[($R+1)*$s-$d]), 648 | Array($fi[ $D*$s], $fi[($L+1)*$s-1], $fi[($F+1)*$s-$d]), 649 | Array($fi[($D+1)*$s-$d], $fi[($B+1)*$s-1], $fi[($L+1)*$s-$d]), 650 | Array($fi[ ($D+1)*$s-1], $fi[($R+1)*$s-1], $fi[($B+1)*$s-$d])); 651 | 652 | // Map the edge positions to facelet ids 653 | $efid = Array( 654 | Array($fi[$U*$s+$m+$h], $fi[ $R*$s+$h]), Array($fi[($U+1)*$s-1-$h], $fi[ $F*$s+$h]), 655 | Array($fi[$U*$s+$m-$h], $fi[ $L*$s+$h]), Array($fi[ $U*$s+$h], $fi[ $B*$s+$h]), 656 | Array($fi[$D*$s+$m+$h], $fi[($R+1)*$s-1-$h]), Array($fi[ $D*$s+$h], $fi[($F+1)*$s-1-$h]), 657 | Array($fi[$D*$s+$m-$h], $fi[($L+1)*$s-1-$h]), Array($fi[($D+1)*$s-1-$h], $fi[($B+1)*$s-1-$h]), 658 | Array($fi[$F*$s+$m+$h], $fi[ $R*$s+$m-$h]), Array($fi[ $F*$s+$m-$h], $fi[ $L*$s+$m+$h]), 659 | Array($fi[$B*$s+$m+$h], $fi[ $L*$s+$m-$h]), Array($fi[ $B*$s+$m-$h], $fi[ $R*$s+$m+$h])); 660 | 661 | 662 | 663 | //print_r($efid); 664 | /* 665 | // Map the corner positions to facelets 666 | $ccol = Array( 667 | Array($U, $R, $F), Array($U, $F, $L), Array($U, $L, $B), Array($U, $B, $R), 668 | Array($D, $F, $R), Array($D, $L, $F), Array($D, $B, $L), Array($D, $R, $B)); 669 | 670 | // Map the edge positions to facelets 671 | $ecol = Array( 672 | Array($U, $R), Array($U, $F), Array($U, $L), 673 | Array($U, $B), Array($D, $R), Array($D, $F), 674 | Array($D, $L), Array($D, $B), Array($F, $R), 675 | Array($F, $L), Array($B, $L), Array($B, $R)); 676 | */ 677 | // Map of centre facelet positions 678 | $mpos = Array($U*$s+$m, $R*$s+$m, $F*$s+$m, $D*$s+$m, $L*$s+$m, $B*$s+$m); 679 | 680 | // Map of corner facelet positions (for any dimensoin of cube) 681 | $cpos = Array( 682 | Array( ($U+1)*$s-1, $R*$s, $F*$s+$d-1), Array(($U+1)*$s-$d, $F*$s, $L*$s+$d-1), 683 | Array( $U*$s, $L*$s, $B*$s+$d-1), Array( $U*$s+$d-1, $B*$s, $R*$s+$d-1), 684 | Array( $D*$s+$d-1, ($F+1)*$s-1, ($R+1)*$s-$d), Array( $D*$s, ($L+1)*$s-1, ($F+1)*$s-$d), 685 | Array(($D+1)*$s-$d, ($B+1)*$s-1, ($L+1)*$s-$d), Array( ($D+1)*$s-1, ($R+1)*$s-1, ($B+1)*$s-$d)); 686 | 687 | // Map edge facelet positions (for any dimensoin) 688 | $epos = Array( 689 | Array($U*$s+$m+$h, $R*$s+$h), Array(($U+1)*$s-1-$h, $F*$s+$h), Array($U*$s+$m-$h, $L*$s+$h), 690 | Array( $U*$s+$h, $B*$s+$h), Array( $D*$s+$m+$h, ($R+1)*$s-1-$h), Array( $D*$s+$h, ($F+1)*$s-1-$h), 691 | Array($D*$s+$m-$h, ($L+1)*$s-1-$h), Array(($D+1)*$s-1-$h, ($B+1)*$s-1-$h), Array($F*$s+$m+$h, $R*$s+$m-$h), 692 | Array($F*$s+$m-$h, $L*$s+$m+$h), Array( $B*$s+$m+$h, $L*$s+$m-$h), Array($B*$s+$m-$h, $R*$s+$m+$h)); 693 | 694 | // Corners 695 | for($i = 0; $i < 8; $i++){ 696 | $j = $cube[1][$i]; // cornercubie with index j is at 697 | // cornerposition with index i 698 | $o = $cube[2][$i]; // Orientation of this cubie 699 | for($n = 0; $n < 3; $n++) $fo[$cpos[$i][($n + $o) % 3]] = $cfid[$j][$n]; 700 | } 701 | //print_r($mfid); 702 | //echo "\n
"; 703 | // Pieces only applicable to odd sized puzzles 704 | if($d % 2 == 1){ 705 | // Centers 706 | for($i = 0; $i < 6; $i++){ 707 | //echo "\n
".$cube[0][$i]; 708 | $fo[$mpos[$i]] = $mfid[$cube[0][$i]]; 709 | } 710 | // Centre edges 711 | for($i = 0; $i < 12; $i++){ 712 | $j = $cube[3][$i]; // edgecubie with index j is at edgeposition with index i 713 | $o = $cube[4][$i]; // Orientation of this cubie 714 | for($n = 0; $n < 2; $n++) $fo[$epos[$i][($n + $o) % 2]] = $efid[$j][$n]; 715 | } 716 | } 717 | //print_r( $fo); 718 | return $fo; 719 | } 720 | 721 | // Convert cubie cube to letter cube (letters representing facelets) 722 | function letter_cube($cube, $dim){ 723 | global $FACE_NAMES; 724 | $fc = face_cube($cube, $dim); 725 | for($i = 0; $i < count($fc); $i++){ 726 | $lc[$i] = $FACE_NAMES[$fc[$i]]; 727 | } 728 | return implode($lc); 729 | } 730 | 731 | // Convert cubie cube to colour cube 732 | function col_cube($cube, $dim){ 733 | // Sheme mapping 734 | $FACE_COL = Array( 735 | 'u' => 'y', 736 | 'r' => 'r', 737 | 'f' => 'b', 738 | 'd' => 'w', 739 | 'l' => 'o', 740 | 'b' => 'g'); 741 | $fc = face_cube($cube, $dim); 742 | // Translate face defs into colour defs 743 | for($i = 0; $i < strlen($fc); $i++){ 744 | $col .= $FACE_COL[$fc[$i]]; 745 | } 746 | return $col; 747 | } 748 | 749 | // Print a cube to screen for debugging 750 | function printcube($cube, $dim){ 751 | $fc = letter_cube($cube, $dim); 752 | println(""); 753 | } 754 | 755 | // Applys an alg to the given cube 756 | function apply_alg($alg, $cube){ 757 | global $CUBIE_MOVES; 758 | $i = 0; 759 | $len = strlen($alg); 760 | while($i < $len){ 761 | $move = move_id(substr($alg, $i, 1)); 762 | if($move >= 0){ 763 | $pow = move_pow(substr($alg, $i+1, 1)); 764 | if($pow > 1) $i++; 765 | // Make the move 766 | $cube = prod($cube, $CUBIE_MOVES[$move], $pow); 767 | } 768 | $i++; 769 | } 770 | return $cube; 771 | } 772 | // Formats an inputed alg to remove dissallowed characters and standardise notation 773 | function format_alg($moves){ 774 | // Remove characters not allowed in an alg 775 | $r = preg_replace('/[^UDLRFBudlrfbMESxyzw\'`23]/', '', $moves); 776 | $r = preg_replace('/[3`]/', "'", $r); // Replace 3 or ` with a ' 777 | $r = preg_replace('/2\'|\'2/', "2", $r); // Replace 2' or '2 with a 2 778 | // Fix wide notation 779 | if(preg_match('/w/', $r)){ 780 | $r = preg_replace('/Uw/', 'u', $r); 781 | $r = preg_replace('/Rw/', 'r', $r); 782 | $r = preg_replace('/Fw/', 'f', $r); 783 | $r = preg_replace('/Dw/', 'd', $r); 784 | $r = preg_replace('/Lw/', 'l', $r); 785 | $r = preg_replace('/Bw/', 'b', $r); 786 | // now remove any extra w's 787 | $r = preg_replace('/w/', '', $r); 788 | } 789 | // Merge multiple moves/rotations of same face 790 | //println( "init moves=|$moves|"); 791 | return compress_alg($r); 792 | //println("compressed moves=|$moves|"); 793 | } 794 | // Removes all initial and final rotations from a cube 795 | function trim_rotations($alg, $is_ll){ 796 | //echo "isll?$is_ll"; 797 | // Remove AUFs if its an LL alg 798 | if($is_ll) $alg = remove_auf($alg); 799 | 800 | // Strip all initial rotations 801 | $alg = preg_replace('/^([xyz][2\']?)+/', '', $alg); 802 | // Strip all final rotations 803 | $alg = preg_replace('/([xyz][2\']?)+$/', '', $alg); 804 | //echo "moves=|$moves|"; 805 | return $alg; 806 | } 807 | // Removes AUFs and replaces them with y rotations 808 | function remove_auf($alg){ 809 | $n = strlen($alg); 810 | for($i = 0; $i < $n; $i++){ 811 | $c = substr($alg, $i, 1); 812 | if($c == 'U') $alg[$i] = 'y'; 813 | else if(preg_match('/[^yU2\'\s]/', $c)) // anything other than y and U turns are no longer aufs 814 | break; 815 | } 816 | for($i = $n - 1; $i > -1; $i--){ 817 | $c = substr($alg, $i, 1); 818 | if($c == 'U') $alg[$i] = 'y'; 819 | else if(preg_match('/[^yU2\'\s]/', $c)) // anything other than y and U turns are no longer aufs 820 | break; 821 | } 822 | return compress_alg($alg); 823 | } 824 | // Inserts spaces in an alg for display 825 | function expand_alg($alg){ 826 | $n = strlen($alg); 827 | $i = 1; 828 | $exp = substr($alg, 0, 1); 829 | while($i < $n){ 830 | $c = substr($alg, $i, 1); 831 | if(move_id($c) != -1) $exp .= " "; 832 | $exp .= $c; 833 | $i++; 834 | } 835 | return $exp; 836 | } 837 | // Merges unnecessery repeated moves of the same face 838 | function compress_alg($alg){ 839 | global $ALG_POW; 840 | $merge_done = true; 841 | while($merge_done && strlen($alg) > 1){ 842 | $n = strlen($alg); 843 | $i = 0; 844 | $merge_done = false; 845 | while($i < $n){ 846 | $move = $alg[$i]; 847 | if(move_id($move) != -1){ 848 | $pow = 1; 849 | if($i < $n -1) $pow = move_pow($alg[$i + 1]); 850 | if($pow > 1) $i++; 851 | // If moves the same, then simply add up powers 852 | if($lmove == $move){ 853 | $lpow += $pow; 854 | $merge_done = true; 855 | } 856 | // Otherwise, last move can be added to alg 857 | else{ 858 | $lpow = $lpow % 4; 859 | if($lpow > 0) $malg .= $lmove . $ALG_POW[$lpow-1]; 860 | $lpow = $pow; 861 | $lmove = $move; 862 | } 863 | } 864 | $i++; 865 | } 866 | // Add final move 867 | $lpow = $lpow % 4; 868 | if($lpow > 0) $malg .= $lmove . $ALG_POW[$lpow-1]; 869 | $alg = $malg; 870 | $malg = null; 871 | $lmove = null; 872 | $lpow = null; 873 | } 874 | return $alg; 875 | } 876 | 877 | // Inverts an NxN cube algorithm 878 | function invert_alg($alg){ 879 | global $ALG_POW; 880 | $inv = ""; 881 | $pow = 1; 882 | $pre = ''; 883 | $i = strlen($alg) - 1; 884 | while($i >= 0){ 885 | $c = substr($alg, $i, 1); 886 | $mv = fcs_move_id($c); 887 | if($mv != -1){ 888 | // Retrive layer depth 889 | if($i > 0){ 890 | $pre = substr($alg, $i-1, 1); 891 | if(!is_numeric($pre) || ($i > 1 892 | && fcs_move_id(substr($alg, $i-2, 1)) != -1)) 893 | $pre = ''; 894 | else $i--; 895 | } 896 | // Invert and add the move 897 | $inv .= $pre . $c . $ALG_POW[3 - $pow] . ' '; 898 | $pow = 1; $pre = ''; 899 | } 900 | else $pow = move_pow(substr($alg, $i, 1)); 901 | $i--; 902 | } 903 | return $inv; 904 | } 905 | 906 | // Returns an array of algorithm statistics 907 | // including, STM, HTM, QTM and GEN 908 | function alg_stats($alg){ 909 | $n = strlen($alg); 910 | $i = 0; 911 | $gen = Array(0, 0, 0, 0, 0, 0, 0, 0, 0); 912 | while($i < $n){ 913 | $move = move_id(substr($alg, $i, 1)); 914 | if($move != -1){ 915 | $pow = 1; 916 | if($i < $n -1) $pow = move_pow(substr($alg, $i + 1, 1)); 917 | // If move not a rotation 918 | if($move <= 14){ 919 | $stm++; 920 | $htm++; 921 | $qtm_ = 1; 922 | // If its a slice move 923 | if($move >= 12 && $move <=14){ 924 | $htm++; 925 | $qtm_ = 2; 926 | } 927 | if($pow == 2) $qtm_ *= 2; 928 | $qtm += $qtm_; 929 | $gen[$move >= 6 ? $move - 6 : $move] = 1; 930 | } 931 | } 932 | $i++; 933 | } 934 | $gn = 0; 935 | foreach($gen as $g) $gn += $g; 936 | return Array($stm, $htm, $qtm, $gn); 937 | } 938 | 939 | // Encode orientation 940 | function encode_o($data, $mod){ 941 | $o = 0; 942 | for($i = 0; $i < count($data); $i++){ 943 | $o = $o * $mod + $data[$i]; 944 | } 945 | return $o; 946 | } 947 | 948 | // Encode permutation 949 | function encode_p($data){ 950 | $p = 0; 951 | $n = count($data); 952 | for($i = 0; $i < $n - 1; $i++){ 953 | $p = $p * ($n - $i + 1); 954 | for($j = $i + 1; $j < $n; $j++){ 955 | if($data[$i] > $data[$j]) 956 | $p += 1; 957 | } 958 | } 959 | return $p; 960 | } 961 | 962 | // Returns whether the cubes match 963 | // Entries of -1 are counted as matching 964 | function cube_match($cube1, $cube2){ 965 | for($i = 0; $i < count($cube1); $i++){ 966 | if(is_array($cube1[$i])){ 967 | if(!cube_match($cube1[$i], $cube2[$i])) return false; 968 | }else if(!( 969 | $cube1[$i] == $cube2[$i] 970 | || $cube1[$i] == -1 971 | || $cube2[$i] == -1)) 972 | return false; 973 | 974 | } 975 | return true; 976 | } 977 | 978 | // Permutes and orients cube1 by cube2 n times 979 | function prod($cube1, $cube2, $n){ 980 | for($i = 0; $i < $n; $i++){ 981 | // Centres 982 | $tmp = Array(); 983 | for($m = 0; $m < 6; $m++){ 984 | // Permute center 985 | $tmp[0][$m] = $cube1[0][$cube2[0][$m]]; 986 | } 987 | // Corners 988 | for($c = 0; $c < 8; $c++){ 989 | // Permute corner 990 | $tmp[1][$c] = $cube1[1][$cube2[1][$c]]; 991 | // Orient corner 992 | $tmp[2][$c] = ($cube1[2][$cube2[1][$c]] + $cube2[2][$c]) % 3; 993 | } 994 | // Edges 995 | for($e = 0; $e < 12; $e++){ 996 | // Permute edge 997 | $tmp[3][$e] = $cube1[3][$cube2[3][$e]]; 998 | // Orient edge 999 | $tmp[4][$e] = ($cube1[4][$cube2[3][$e]] + $cube2[4][$e]) % 2; 1000 | } 1001 | $cube1 = $tmp; 1002 | } 1003 | return $cube1; 1004 | } 1005 | 1006 | // Returns the power of a move with given suffix 1007 | function move_pow($char){ 1008 | switch($char){ 1009 | case "2" : return 2; 1010 | case "'" : return 3; 1011 | case "3" : return 3; 1012 | } 1013 | return 1; 1014 | } 1015 | 1016 | // Maps move names to a move id 1017 | function move_id($move){ 1018 | switch($move){ 1019 | case 'U': return 0; 1020 | case 'R': return 1; 1021 | case 'F': return 2; 1022 | case 'D': return 3; 1023 | case 'L': return 4; 1024 | case 'B': return 5; 1025 | case 'u': return 6; 1026 | case 'r': return 7; 1027 | case 'f': return 8; 1028 | case 'd': return 9; 1029 | case 'l': return 10; 1030 | case 'b': return 11; 1031 | case 'E': return 12; 1032 | case 'M': return 13; 1033 | case 'S': return 14; 1034 | case 'y': return 15; 1035 | case 'x': return 16; 1036 | case 'z': return 17; 1037 | } 1038 | return -1; 1039 | } 1040 | 1041 | 1042 | 1043 | // -----------------[ NxNxN Face Cube ]--------------- 1044 | 1045 | // Permutes an NxNxN face definition according to the given alg 1046 | function fcs_doperm($fcs, $alg, $dim){ 1047 | $nf = $dim * $dim; 1048 | $mt = Array(); 1049 | // Generate basic move tables 1050 | // Twist generic face 1051 | $fc_twist = Array(); 1052 | for($row = 0; $row < $dim; $row++){ 1053 | for($col = 0; $col < $dim; $col++){ 1054 | $fc_twist[$row * $dim + $col] = ($dim - $col - 1) * $dim + $row; 1055 | } 1056 | } 1057 | // Inverse twist 1058 | $fc_twist2 = Array(); 1059 | for($row = 0; $row < $dim; $row++){ 1060 | for($col = 0; $col < $dim; $col++){ 1061 | $fc_twist2[$row * $dim + $col] = $col * $dim + $dim - $row - 1; 1062 | } 1063 | } 1064 | 1065 | // Face order for slice turns 1066 | $sl_fo = Array( 1067 | Array(6, 5, 1, 6, 2, 4), // x 1068 | Array(2, 6, 3, 5, 6, 0), // y 1069 | Array(4, 0, 6, 1, 3, 6), // z 1070 | Array(6, 2, 4, 6, 5, 1), // x' 1071 | Array(5, 6, 0, 2, 6, 3), // y' 1072 | Array(1, 3, 6, 4, 0, 6), // z' 1073 | ); 1074 | // Sticker order for slice turns 1075 | $sl_so = Array( // 1=+col+row, 2=-col+row, 3=+col-row, 4=-col-row, 1076 | // 5=+row+col, 6=-row+col, 7=+row-col, 8=-row-col, 0=null 1077 | Array(0, 1, 1, 0, 1, 1), // x 1078 | Array(8, 0, 8, 8, 0, 5), // y 1079 | Array(4, 7, 0, 1, 6, 0), // z 1080 | ); 1081 | // Twist individual slices 1082 | $sl_twist = Array(); 1083 | for($lr = 0; $lr < 6; $lr++){ 1084 | $sl_twist[$lr] = Array(); 1085 | for($sl = 0; $sl < $dim; $sl++){ 1086 | $sl_twist[$lr][$sl] = Array(); 1087 | for($fc = 0; $fc < 6; $fc++){ 1088 | if($sl_so[$lr%3][$fc] == 0) continue; 1089 | for($i = 0; $i < $dim; $i++){ 1090 | $sl_twist[$lr][$sl][$fc*$nf + fcs_pos($sl, $i, $sl_so[$lr%3][$fc], $dim)] 1091 | = $sl_fo[$lr][$fc]*$nf + fcs_pos($sl, $i, $sl_so[$lr%3][$sl_fo[$lr][$fc]], $dim); 1092 | } 1093 | } 1094 | } 1095 | } 1096 | // Initialise move tables 1097 | $fc_moves = Array(); 1098 | for($i = 0; $i < $dim * 6; $i++){ 1099 | for($j = 0; $j < $nf * 6; $j++){ 1100 | $fc_moves[$i][$j] = $j; 1101 | } 1102 | } 1103 | 1104 | // Create move tables composed of simple units 1105 | 1106 | // Rotations 1107 | for($i = 0; $i < 3; $i++){ 1108 | // Add all slice moves for axis 1109 | for($j = 0; $j < $dim; $j++) 1110 | fcs_union($fc_moves[$i], $sl_twist[$i][$j], 0); 1111 | // Add twist moves for each end 1112 | fcs_union($fc_moves[$i], $fc_twist, $i*$dim*$dim); 1113 | fcs_union($fc_moves[$i], $fc_twist2, ($i+3)*$dim*$dim); 1114 | } 1115 | // Centre-slice moves 1116 | if($dim % 2 > 0){ 1117 | fcs_union($fc_moves[3], $sl_twist[3][floor($dim/2)], 0); // E 1118 | fcs_union($fc_moves[4], $sl_twist[4][floor($dim/2)], 0); // M 1119 | fcs_union($fc_moves[5], $sl_twist[2][floor($dim/2)], 0); // S 1120 | } 1121 | 1122 | // Normal Moves 1123 | for($ax = 0; $ax < 3; $ax++){ 1124 | for($dp = 0; $dp < $dim - 1; $dp++){ 1125 | // Primary axis end 1126 | // Add twist move 1127 | fcs_union($fc_moves[6 + $ax*($dim-1) + $dp], $fc_twist, $ax*$dim*$dim); 1128 | for($sl = 0; $sl <= $dp; $sl++) // Add slice moves up to depth $dp 1129 | fcs_union($fc_moves[6 + $ax*($dim-1) + $dp], $sl_twist[$ax][$sl], 0); 1130 | // Secondary axis end 1131 | // Add twist move 1132 | fcs_union($fc_moves[6 + (3+$ax)*($dim-1) + $dp], $fc_twist, (3+$ax)*$dim*$dim); 1133 | for($sl = 0; $sl <= $dp; $sl++) // Add slice moves up to depth $dp 1134 | fcs_union($fc_moves[6 + (3+$ax)*($dim-1) + $dp], $sl_twist[3+$ax][$dim - $sl - 1], 0); 1135 | } 1136 | } 1137 | 1138 | // Carry out moves 1139 | $moves = fcs_parse_alg($alg, $dim); 1140 | 1141 | $fcs_ = Array(); 1142 | if(!is_array($fcs)) $fcs = str_split($fcs); 1143 | foreach($moves as $mv){ 1144 | fcs_permute($fcs, $fcs_, $fc_moves[$mv]); 1145 | $tmp = $fcs; 1146 | $fcs = $fcs_; 1147 | $fcs_ = $tmp; 1148 | } 1149 | return $fcs; 1150 | } 1151 | function fcs_pos($r, $c, $o, $d){ 1152 | $n = $d*$d; 1153 | switch($o){ 1154 | case 1: return $d * $r + $c; 1155 | case 2: return $d * ($r + 1) - 1 - $c; 1156 | case 3: return $n - $d * ($r + 1) + $c; 1157 | case 4: return $n - $d * $r - 1 - $c; 1158 | case 5: return $d * $c + $r; 1159 | case 6: return $d * ($c + 1) - 1 - $r; 1160 | case 7: return $n - $d * ($c + 1) + $r; 1161 | case 8: return $n - $d * $c - 1 - $r; 1162 | } 1163 | } 1164 | // Translations defined in $t2 are applied to $t1 1165 | function fcs_union(&$t1, &$t2, $offset){ 1166 | foreach($t2 as $k => $v){ 1167 | $t1[$k + $offset] = $v + $offset; 1168 | } 1169 | } 1170 | // Permutes given array, storing output in second array 1171 | function fcs_permute(&$in, &$out, $perm){ 1172 | //print_r($perm); 1173 | for($i = 0; $i < count($in); $i++) 1174 | $out[$i] = $in[$perm[$i]]; 1175 | //print_r($out); 1176 | return $out; 1177 | } 1178 | // Parses an algorithm string into a move-id sequence 1179 | function fcs_parse_alg($alg, $dim){ 1180 | $moves = Array(); 1181 | $i = 0; 1182 | $j = 0; 1183 | $pre = 0; 1184 | $len = strlen($alg); 1185 | while($i < $len){ 1186 | $c = substr($alg, $i, 1); 1187 | $mv = fcs_move_id($c); 1188 | if(is_numeric($c)){ 1189 | $pre = $c; 1190 | } 1191 | else if($mv >= 0){ 1192 | $pow = $i < strlen($alg) - 1 ? move_pow(substr($alg, $i+1, 1)) : 1; 1193 | if($pow > 1) $i++; 1194 | // Add the move 1195 | $pre = $pre < 1 ? 1 : ($pre > $dim - 1 ? $dim - 1 : $pre); 1196 | if($mv >= 12){ $mv -= 6; $pre = $pre < 2 ? 2 : $pre; } 1197 | for($k = 0; $k < $pow; $k++) 1198 | $moves[$j++] = $mv < 6 ? $mv : 6 + ($mv - 6) * ($dim - 1) + ($pre - 1); 1199 | $pre = 1; 1200 | } 1201 | else $pre = 1; 1202 | 1203 | $i++; 1204 | } 1205 | // echo "|" . $alg . "|"; 1206 | // print_r($moves); 1207 | 1208 | return $moves; 1209 | } 1210 | // Maps move names to a move id 1211 | function fcs_move_id($move){ 1212 | switch($move){ 1213 | case 'y': return 0; 1214 | case 'x': return 1; 1215 | case 'z': return 2; 1216 | case 'E': return 3; 1217 | case 'M': return 4; 1218 | case 'S': return 5; 1219 | case 'U': return 6; 1220 | case 'R': return 7; 1221 | case 'F': return 8; 1222 | case 'D': return 9; 1223 | case 'L': return 10; 1224 | case 'B': return 11; 1225 | case 'u': return 12; 1226 | case 'r': return 13; 1227 | case 'f': return 14; 1228 | case 'd': return 15; 1229 | case 'l': return 16; 1230 | case 'b': return 17; 1231 | } 1232 | return -1; 1233 | } 1234 | // Formats an alg for bigcubes 1235 | function fcs_format_alg($alg){ 1236 | // Fix URL encoded characters (urldecode doesn't seem to remove them) 1237 | $r = preg_replace('/%27/', "'", $alg); 1238 | $r = preg_replace('/%20/', " ", $r); 1239 | // Remove characters not allowed in an alg 1240 | $r = preg_replace('/[^UDLRFBudlrfbMESxyzw\'`234567890 ]/', '', $r); 1241 | $r = preg_replace('/[`]/', "'", $r); // Replace ` with a ' 1242 | $r = preg_replace('/2\'|\'2/', "2", $r); // Replace 2' or '2 with a 2 1243 | // Fix wide notation 1244 | if(preg_match('/[w]/', $r)){ 1245 | $r = preg_replace('/Uw/', 'u', $r); 1246 | $r = preg_replace('/Rw/', 'r', $r); 1247 | $r = preg_replace('/Fw/', 'f', $r); 1248 | $r = preg_replace('/Dw/', 'd', $r); 1249 | $r = preg_replace('/Lw/', 'l', $r); 1250 | $r = preg_replace('/Bw/', 'b', $r); 1251 | // now remove any extra w's 1252 | $r = preg_replace('/w/', '', $r); 1253 | } 1254 | return $r; 1255 | } 1256 | // ------------------[ Basic Functions ]-------------- 1257 | 1258 | // Copy an array 1259 | function array_copy($ary){ 1260 | if(!is_array($ary)) return $ary; 1261 | $out = Array(count($ary)); 1262 | foreach($ary as $k => $v){ 1263 | $out[$k] = array_copy($v); 1264 | } 1265 | return $out; 1266 | } 1267 | 1268 | ?> 1269 | -------------------------------------------------------------------------------- /db_schema.sql: -------------------------------------------------------------------------------- 1 | /** Caches generated visual cubes. 2 | Stores the parameters used to generate the image, 3 | the latest referrer to request the image, 4 | and the request frequencey */ 5 | CREATE TABLE vcache( 6 | hash CHAR(32) NOT NULL, 7 | fmt CHAR(4) NOT NULL, 8 | req VARCHAR(255) NOT NULL, 9 | rfr VARCHAR(255) NOT NULL, 10 | rcount INT UNSIGNED NOT NULL, 11 | img MEDIUMBLOB, 12 | PRIMARY KEY (hash)); 13 | 14 | /** View contents with: */ 15 | SELECT hash, fmt, req, rfr, rcount, OCTET_LENGTH(img) FROM vcache; 16 | 17 | -------------------------------------------------------------------------------- /screen.css: -------------------------------------------------------------------------------- 1 | body{ 2 | margin:0; 3 | text-align:center; 4 | font-size:10pt; 5 | font-family:Verdana, Geneva, Arial, Helvetica, sans-serif; 6 | } 7 | 8 | h1{ 9 | color:#888; 10 | text-decoration:none; 11 | font-family:Arial, Helvetica, sans-serif; 12 | font-size:1.8em; 13 | font-weight:bold; 14 | } 15 | 16 | h2{ 17 | margin-top:6em; 18 | font-size:1.2em; 19 | font-weight:bold; 20 | } 21 | h3{ 22 | margin-top:2em; 23 | font-size:1.0em; 24 | font-weight:bold; 25 | } 26 | em{ 27 | font-style:normal; 28 | font-weight:bold; 29 | } 30 | img{ 31 | border:0; 32 | float:right; 33 | } 34 | .imgarea{ 35 | text-align:center; 36 | } 37 | .imgarea img{ 38 | float:none; 39 | } 40 | .imglist img{ 41 | float:right; 42 | } 43 | .biglist li{ 44 | margin-bottom:15px; 45 | } 46 | .it{ 47 | font-style:italic; 48 | } 49 | .capimg2{ 50 | float:left; 51 | width:220px; 52 | text-align:center; 53 | font-size:0.8em; 54 | } 55 | .capimg2 img{ 56 | float:none; 57 | } 58 | .capimg3{ 59 | float:left; 60 | width:150px; 61 | text-align:center; 62 | font-size:0.8em; 63 | } 64 | .capimg3 img{ 65 | float:none; 66 | } 67 | .imglist li{ 68 | clear:both; 69 | } 70 | #container{ 71 | width:800px; 72 | min-height:350px; 73 | margin:10px auto 0 auto; 74 | background-image:url('bg.png'); 75 | background-repeat:no-repeat; 76 | } 77 | #header{ 78 | width:450px; 79 | margin:0 auto; 80 | text-align:left; 81 | } 82 | 83 | #header a{ 84 | } 85 | 86 | #header img{ 87 | float:right; 88 | border:none; 89 | } 90 | 91 | #nav_box{ 92 | text-align:left; 93 | float:right; 94 | margin-right:20px; 95 | margin-top:20px; 96 | border:1px solid #888888; 97 | background:#888888; 98 | font-weight:bold; 99 | color:#FFFFFF; 100 | } 101 | #nav_box ul{ 102 | list-style:none; 103 | padding:5px; 104 | margin:0px; 105 | background:#F8F8F8; 106 | } 107 | #nav_box li{ 108 | color:#666666; 109 | font-weight:normal; 110 | margin:1px 0; 111 | } 112 | 113 | #content{ 114 | width:450px; 115 | margin:20px auto; 116 | text-align:left; 117 | font-size:1em; 118 | } 119 | 120 | #content .backlink{ 121 | margin-top:10px; 122 | } 123 | 124 | #footer{ 125 | width:450px; 126 | margin:0 auto; 127 | font-size:0.8em; 128 | color:#AAA; 129 | } 130 | .spaced_box{ 131 | margin-top:50px; 132 | } 133 | .term_list{ 134 | list-style:none; 135 | padding-left:20px; 136 | } 137 | .term_list li{ 138 | clear:both; 139 | padding-top:10px; 140 | } 141 | .term_list em{ 142 | display:block; 143 | float:left; 144 | } 145 | .term_list span{ 146 | display:block; 147 | font-weight:normal; 148 | width:300px; 149 | float:right; 150 | } 151 | .form{ 152 | margin-top:20px; 153 | text-align:center; 154 | } 155 | .form_content{ 156 | width:350px; 157 | margin:0 auto; 158 | padding:5px 10px; 159 | background:transparent; 160 | border:0px solid #CCC; 161 | } 162 | .form_record{ 163 | clear:both; 164 | } 165 | .form_record .label{ 166 | text-align:left; 167 | width:130px; 168 | float:left; 169 | margin:7px 0; 170 | } 171 | .form_record .data{ 172 | text-align:left; 173 | float:right; 174 | margin:7px 0; 175 | } 176 | .form_record .data input,select,textarea{ 177 | width:200px; 178 | } 179 | .form_record .data textarea{ 180 | height:4em; 181 | } 182 | .form_textbox{ 183 | clear:both; 184 | } 185 | .form_textbox textarea{ 186 | width:100%; 187 | height:8em; 188 | } 189 | .form_submit{ 190 | clear:both; 191 | text-align:right; 192 | } 193 | 194 | -------------------------------------------------------------------------------- /visualcube.php: -------------------------------------------------------------------------------- 1 | , Jaume Casado Ruiz 7 | Description: Main script to generate cube images 8 | 9 | This file is part of VisualCube. 10 | 11 | VisualCube is free software: you can redistribute it and/or modify 12 | it under the terms of the GNU Lesser General Public License as published by 13 | the Free Software Foundation, either version 3 of the License, or 14 | (at your option) any later version. 15 | 16 | VisualCube is distributed in the hope that it will be useful, 17 | but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | GNU Lesser General Public License for more details. 20 | 21 | You should have received a copy of the GNU Lesser General Public License 22 | along with Foobar. If not, see . 23 | 24 | Copyright (C) 2010 Conrad Rider 25 | 26 | TODO: 27 | * Automatic Permutation Arrows 28 | * Other puzzles 29 | 30 | CHANGES: 31 | (Version 0.5.5 to 0.5.6) 32 | * Modified options to attempt to fix rendering issues in ImageMagick v6.9.x 33 | (Version 0.5.4 to 0.5.5) 34 | * Changed to using style attribute to fix transparrancy issues 35 | (Version 0.5.3 to 0.5.4) 36 | * Added configurable DB host 37 | * Added configurable path to ImageMagick convert binary 38 | (Version 0.5.2 to 0.5.3) 39 | * Fixed links on API page 40 | * Changed default format to SVG, avoiding ImageMagick failures 41 | * Addressed PHP warnings and fixed typos in the code 42 | (Version 0.5.1 to 0.5.2) 43 | * Separate configuration file 44 | * Separate API definition file - easier to provide custom API page 45 | (Version 0.3.0 to 0.4.0) 46 | * Algs applicable to NxNxN cubes 47 | * Wider range of stage masks, with the ability to rotate them 48 | * Style variables configurable via cookies 49 | 50 | 51 | */ 52 | 53 | // Import configuration values 54 | require 'visualcube_config.php'; 55 | 56 | global 57 | $DB_HOST, 58 | $DB_NAME, 59 | $DB_USERNAME, 60 | $DB_PASSWORD, 61 | $MAX_PZL_DIM, 62 | $ENABLE_COOKIES, 63 | $ENABLE_CACHE, 64 | $CACHE_IMG_SIZE_LIMIT, 65 | $DEFAULTS; 66 | 67 | 68 | // VisualCube version 69 | $VERSION = "0.5.5"; 70 | 71 | 72 | // Causes cube svg to be outputted as XML for inspection 73 | $DEBUG = false; 74 | // Do not display errors 75 | // if (!$DEBUG) error_reporting(0); 76 | 77 | 78 | // ----------------------[ API Page ]----------------------- 79 | 80 | // If no format specified, display API page 81 | if(!array_key_exists('fmt', $_REQUEST)){ 82 | 83 | include 'visualcube_api.php'; 84 | 85 | // Otherwise render a cube 86 | }else{ 87 | // Check cache for image and return if it exists in cache 88 | if($ENABLE_CACHE){ 89 | // Connect to db 90 | $mysql_con = mysqli_connect($DB_HOST, $DB_USERNAME, $DB_PASSWORD, $DB_NAME) or die("Connect Error: " . mysqli_connect_error()); 91 | 92 | $hash = md5($_SERVER['QUERY_STRING']); 93 | $imgdata = get_arrays($mysql_con, "SELECT fmt, req, rcount, img FROM vcache WHERE hash='$hash'"); 94 | // Verify query strings are equal (deals with unlikely, but possible hash collisions) 95 | if($imgdata && count($imgdata) > 0 && $imgdata[0]['req'] == $_SERVER['QUERY_STRING']){ 96 | display_img($imgdata[0]['img'], $imgdata[0]['fmt']); 97 | // Increment access count 98 | mysqli_query($mysql_con, "UPDATE vcache SET rcount=rcount+1 WHERE hash='$hash'"); 99 | // Disconnect from db 100 | mysqli_close(); 101 | return; 102 | } 103 | } 104 | 105 | 106 | // Otherwise generate image 107 | 108 | 109 | // -----------------[ Constants ]----------------- 110 | 111 | // Faces 112 | $U = 0; $R = 1; $F = 2; $D = 3; $L = 4; $B = 5; $N = 6; $O = 7; $T = 8; 113 | 114 | 115 | // Colour constants 116 | $BLACK = '000000'; 117 | $DGREY = '404040'; 118 | $GREY = '808080'; 119 | $SILVER = 'BFBFBF'; 120 | $WHITE = 'FFFFFF'; 121 | $YELLOW = 'FEFE00'; 122 | $RED = 'EE0000';//'FE0000'; 123 | $ORANGE = 'FFA100';//'FE8600'; 124 | $BLUE = '0000F2'; 125 | $GREEN = '00D800';//'00F300'; 126 | $PURPLE = 'A83DD9'; 127 | $PINK = 'F33D7B'; 128 | 129 | // Other colour schemes 130 | // Array('FFFF00', 'FF0000', '0000FF', 'FFFFFF', 'FF7F00', '00FF00'); // Basic 131 | // Array('EFEF00', 'C80000', '0000B6', 'F7F7F7', 'FFA100', '00B648'); // Cubestation 132 | // Array('EFFF01', 'FF0000', '1600FF', 'FEFFFC', 'FF8000', '047F01'); // cube.rider 133 | // Array('FEFE00', 'FE0000', '0000F2', 'FEFEFE', 'FE8600', '00F300'); // alg.garron 134 | 135 | // Name colour mapping 136 | $NAME_COL = Array( 137 | 'black' => $BLACK, 138 | 'dgrey' => $DGREY, 139 | 'grey' => $GREY, 140 | 'silver' => $SILVER, 141 | 'white' => $WHITE, 142 | 'yellow' => $YELLOW, 143 | 'red' => $RED, 144 | 'orange' => $ORANGE, 145 | 'blue' => $BLUE, 146 | 'green' => $GREEN, 147 | 'purple' => $PURPLE, 148 | 'pink' => $PINK); 149 | 150 | // Abbreviation colour mapping 151 | $ABBR_COL = Array( 152 | 'n' => $BLACK, 153 | 'd' => $DGREY, 154 | 'l' => $GREY, 155 | 's' => $SILVER, 156 | 'w' => $WHITE, 157 | 'y' => $YELLOW, 158 | 'r' => $RED, 159 | 'o' => $ORANGE, 160 | 'b' => $BLUE, 161 | 'g' => $GREEN, 162 | 'm' => $PURPLE, 163 | 'p' => $PINK, 164 | 't' => 't'); // Transparent 165 | 166 | // Default colour scheme 167 | $DEF_SCHEME = Array ($YELLOW, $RED, $BLUE, $WHITE, $ORANGE, $GREEN, $DGREY, $GREY, 't'); 168 | // $DEF_SCHEME = Array ($WHITE, $RED, $GREEN, $BLUE, $ORANGE, $YELLOW, $GREY, $SILVER, 't'); // Japanese scheme 169 | 170 | // Corresponding mappings from colour code to face id 171 | $DEF_SCHCODE = Array('y', 'r', 'b', 'w', 'o', 'g',); 172 | //$DEF_SCHCODE = Array('w', 'r', 'g', 'b', 'o', 'y',); // Japanese scheme 173 | 174 | 175 | // -----------------------[ User Parameters ]-------------------- 176 | 177 | // Retrieve format from user, default to first in list otherwise 178 | $LEGAL_FMT = Array ('gif', 'png', 'svg', 'jpg', 'jpe', 'jpeg', 'tiff', 'ico'); 179 | $fmt = $LEGAL_FMT[0]; 180 | if(array_key_exists('fmt', $_REQUEST) || array_key_exists('fmt', $DEFAULTS)){ 181 | $fmt = array_key_exists('fmt', $_REQUEST) ? $_REQUEST['fmt'] : $DEFAULTS['fmt']; 182 | if(!in_array($fmt, $LEGAL_FMT)) 183 | $fmt = $LEGAL_FMT[0]; 184 | else{ 185 | if($fmt == 'jpeg' || $fmt == 'jpe') $fmt = 'jpg'; 186 | } 187 | } 188 | 189 | // Default rotation sequence 190 | $rtn = Array(Array(1, 45), Array(0, -34)); 191 | // Get rotation from request (or cookie) 192 | if(array_key_exists('r', $_REQUEST) || array_key_exists('r', $DEFAULTS) 193 | || ($ENABLE_COOKIES && isset($_COOKIE['vc_r']) && $_COOKIE['vc_r'] != '')){ 194 | $_r = array_key_exists('r', $_REQUEST) ? $_REQUEST['r'] : 195 | ($ENABLE_COOKIES && isset($_COOKIE['vc_r']) && $_COOKIE['vc_r'] != '' ? 196 | $_COOKIE['vc_r'] : $DEFAULTS['r']); 197 | preg_match_all('/([xyz])(\-?[0-9][0-9]?[0-9]?)/', $_r, $matches); 198 | for($i = 0; $i < count($matches[0]); $i++){ 199 | switch($matches[1][$i]){ 200 | case 'x' : $rtn_[$i][0] = 0; break; 201 | case 'y' : $rtn_[$i][0] = 1; break; 202 | case 'z' : $rtn_[$i][0] = 2; break; 203 | default : break; 204 | } 205 | $rtn_[$i][1] = $matches[2][$i]; 206 | } 207 | if($rtn_) $rtn = $rtn_; 208 | } 209 | 210 | // Retrieve cube Dimension 211 | $dim = $DEFAULTS['pzl']; 212 | if(array_key_exists('pzl', $_REQUEST) && is_numeric($_REQUEST['pzl']) 213 | && $_REQUEST['pzl'] > 0 && $_REQUEST['pzl'] <= $MAX_PZL_DIM) 214 | $dim = $_REQUEST['pzl']; 215 | 216 | // Default scheme 217 | $scheme = $DEF_SCHEME; 218 | // Default mapping from colour code to face id 219 | $schcode = $DEF_SCHCODE; 220 | // Retrieve colour scheme from request (or cookie) 221 | if(array_key_exists('sch', $_REQUEST) || array_key_exists('sch', $DEFAULTS) 222 | || ($ENABLE_COOKIES && isset($_COOKIE['vc_sch']) && $_COOKIE['vc_sch'] != '')){ 223 | // Retrieve from cookie or 'sch' variable 224 | $sd = array_key_exists('sch', $_REQUEST) ? $_REQUEST['sch'] : 225 | ($ENABLE_COOKIES && isset($_COOKIE['vc_sch']) && $_COOKIE['vc_sch'] != '' ? 226 | $_COOKIE['vc_sch'] : $DEFAULTS['sch']); 227 | if(preg_match('/^[ndlswyrogbpmt]{6}$/', $sd)){ 228 | for($i = 0; $i < 6; $i++){ 229 | $scheme[$i] = $ABBR_COL[$sd[$i]]; 230 | $schcode[$i] = $sd[$i]; 231 | } 232 | } 233 | else{ 234 | $cols = preg_split('/,/', $sd); 235 | if(count($cols) == 6){ 236 | $cok = true; 237 | for($i = 0; $i < 6; $i++){ 238 | $scheme[$i] = parse_col($cols[$i]); 239 | if(!$cols[$i]) $cok = false; 240 | } 241 | if(!$cok) $scheme = $DEF_SCHEME; 242 | } 243 | } 244 | } 245 | 246 | // Retrieve size from user 247 | $size = $DEFAULTS['size']; // default 248 | if(array_key_exists('size', $_REQUEST) && is_numeric($_REQUEST['size'])){ 249 | $size = $_REQUEST['size']; 250 | if($size < 0) $size = 0; 251 | if($size > 1024) $size = 1024; 252 | } 253 | 254 | // Retrieve dist variable - projection distance (how close the eye is to the cube) 255 | $dist = $DEFAULTS['dist']; // default dist parameter 256 | if(array_key_exists('dist', $_REQUEST) || ($ENABLE_COOKIES && isset($_COOKIE['vc_dist']))){ 257 | $dist_ = array_key_exists('dist', $_REQUEST) ? $_REQUEST['dist'] : $_COOKIE['vc_dist']; 258 | if(is_numeric($dist_)) $dist = $dist_ < 1 ? 1 : ($dist_ > 100 ? 100 : $dist_); 259 | } 260 | 261 | // Retrieve view variable 262 | $view = $DEFAULTS['view']; 263 | if(array_key_exists('view', $_REQUEST)){ 264 | $view = $_REQUEST['view']; 265 | } 266 | 267 | // Retrieve background colour from request (or cookies) 268 | $bg = parse_col($DEFAULTS['bg']); 269 | if(!$bg) $bg = 'FFFFFF'; 270 | if(array_key_exists('bg', $_REQUEST) || ($ENABLE_COOKIES && isset($_COOKIE['vc_bg']))){ 271 | $bg_ = array_key_exists('bg', $_REQUEST) ? $_REQUEST['bg'] : $_COOKIE['vc_bg']; 272 | if($bg_ == "t") $bg = null; 273 | else{ 274 | $bg_ = parse_col($bg_); 275 | if($bg_) $bg = $bg_; 276 | } 277 | } 278 | 279 | // Retrieve cube colour from request (or cookies) 280 | $cc = $view == 'trans' ? $SILVER : parse_col($DEFAULTS['cc']); 281 | if(array_key_exists('cc', $_REQUEST) || ($ENABLE_COOKIES && isset($_COOKIE['vc_cc']))){ 282 | $cc_ = array_key_exists('cc', $_REQUEST) ? $_REQUEST['cc'] : $_COOKIE['vc_cc']; 283 | $cc_ = parse_col($cc_); 284 | if($cc_) $cc = $cc_; 285 | } 286 | $cc = !$cc ? $BLACK : $cc; 287 | 288 | // Retrieve cube opacity from request (or cookies) 289 | $co = $view == 'trans' ? 50 : $DEFAULTS['co']; 290 | if(array_key_exists('co', $_REQUEST) || ($ENABLE_COOKIES && isset($_COOKIE['vc_co']))){ 291 | $co_ = array_key_exists('co', $_REQUEST) ? $_REQUEST['co'] : $_COOKIE['vc_co']; 292 | if(preg_match('/^[0-9][0-9]?$/', $co_)) $co = $co_; 293 | } 294 | $co = !is_numeric($co) || $co < 0 || $co > 100 ? 100 : $co; 295 | 296 | // Retrieve face opacity from request (or cookies) 297 | $fo = $DEFAULTS['fo']; 298 | if(!is_numeric($fo) || $fo < 0 || $fo > 100) 299 | $fo = 100; 300 | if(array_key_exists('fo', $_REQUEST) || ($ENABLE_COOKIES && isset($_COOKIE['vc_fo']))){ 301 | $fo_ = array_key_exists('fo', $_REQUEST) ? $_REQUEST['fo'] : $_COOKIE['vc_fo']; 302 | if(preg_match('/^[0-9][0-9]?$/', $fo_)) $fo = $fo_; 303 | } 304 | 305 | 306 | // Create default face defs 307 | for($fc = 0; $fc < 6; $fc++){ for($i = 0; $i < $dim * $dim; $i++) 308 | $facelets[$fc * $dim * $dim + $i] = $fc; 309 | } 310 | // Retrieve colour def 311 | // This overrides face def and makes the $scheme variable redundant (ie, gets reset to default) 312 | $using_cols = false; 313 | $uf = array_key_exists('fc', $_REQUEST) ? $_REQUEST['fc'] : (!array_key_exists('fd', $_REQUEST) ? $DEFAULTS['fc'] : ''); 314 | if(preg_match('/^[ndlswyrobgmpt]+$/', $uf)){ 315 | $using_cols = true; 316 | $scheme = $DEF_SCHEME; 317 | $nf = strlen($uf); 318 | for($fc = 0; $fc < 6; $fc++){ for($i = 0; $i < $dim * $dim; $i++){ 319 | // Add user defined face 320 | if($fc * $dim *$dim + $i < $nf) 321 | $facelets[$fc * $dim * $dim + $i] = $uf[$fc * $dim *$dim + $i]; 322 | // Otherwise use scheme code 323 | else 324 | $facelets[$fc * $dim * $dim + $i] = $schcode[$fc]; 325 | }} 326 | } 327 | // Retrieve facelet def 328 | if(!$uf){ $uf = array_key_exists('fd', $_REQUEST) ? $_REQUEST['fd'] : $DEFAULTS['fd']; 329 | if(preg_match('/^[udlrfbnot]+$/', $uf)){ 330 | // Map from face names to numeric face ID 331 | $fd_map = Array('u' => $U, 'r' => $R, 'f' => $F, 'd' => $D, 'l' => $L, 'b' => $B, 'n' => $N, 'o' => $O, 't' => $T); 332 | $nf = strlen($uf); 333 | for($fc = 0; $fc < 6; $fc++){ for($i = 0; $i < $dim * $dim; $i++){ 334 | // Add user defined face 335 | if($fc * $dim *$dim + $i < $nf) 336 | $facelets[$fc * $dim * $dim + $i] = $fd_map[$uf[$fc * $dim *$dim + $i]]; 337 | // Otherwise default to a blank/transparent face 338 | else $facelets[$fc * $dim *$dim + $i] = $view == 'trans' ? $T : $N; 339 | }} 340 | }} 341 | // Retrieve stage variable 342 | if(array_key_exists('stage', $_REQUEST) || array_key_exists('stage', $DEFAULTS)){ 343 | $stage = array_key_exists('stage', $_REQUEST) ? $_REQUEST['stage'] : $DEFAULTS['stage']; 344 | // Extract rotation sequence if present 345 | $p = strrpos($stage, '-'); 346 | $st_rtn = ''; 347 | if($p > 0){ 348 | $st_rtn = urldecode(substr($stage, $p+1)); 349 | $stage = substr($stage, 0, $p); 350 | } 351 | // Stage Definitions 352 | $mask = ''; 353 | if($dim == 3){ 354 | switch($stage){ 355 | case 'fl' : 356 | $mask = "000000000000000111000000111111111111000000111000000111"; 357 | break; 358 | case 'f2l' : 359 | $mask = "000000000000111111000111111111111111000111111000111111"; 360 | break; 361 | case 'll' : 362 | $mask = "111111111111000000111000000000000000111000000111000000"; 363 | break; 364 | case 'cll' : 365 | $mask = "101010101101000000101000000000000000101000000101000000"; 366 | break; 367 | case 'ell' : 368 | $mask = "010111010010000000010000000000000000010000000010000000"; 369 | break; 370 | case 'oll' : 371 | $mask = "111111111000000000000000000000000000000000000000000000"; 372 | break; 373 | case 'ocll' : 374 | $mask = "101010101000000000000000000000000000000000000000000000"; 375 | break; 376 | case 'oell' : 377 | $mask = "010111010000000000000000000000000000000000000000000000"; 378 | break; 379 | case 'coll' : 380 | $mask = "111111111101000000101000000000000000101000000101000000"; 381 | break; 382 | case 'ocell' : 383 | $mask = "111111111010000000010000000000000000010000000010000000"; 384 | break; 385 | case 'wv' : 386 | $mask = "111111111000111111000111111111111111000111111000111111"; 387 | break; 388 | case 'vh' : 389 | $mask = "010111010000111111000111111111111111000111111000111111"; 390 | break; 391 | case 'els' : 392 | $mask = "010111010000111011000111110110111111000111111000111111"; 393 | break; 394 | case 'cls' : 395 | $mask = "111111111000111111000111111111111111000111111000111111"; 396 | break; 397 | case 'cmll' : 398 | $mask = "101000101101111111101101101101101101101111111101101101"; 399 | break; 400 | case 'cross' : 401 | $mask = "000000000000010010000010010010111010000010010000010010"; 402 | break; 403 | case 'f2l_3' : 404 | $mask = "000000000000110110000011011011111010000010010000010010"; 405 | break; 406 | case 'f2l_2' : 407 | $mask = "000000000000011011000010010010111111000110110000111111"; 408 | break; 409 | case 'f2l_sm' : 410 | $mask = "000000000000110110000011011011111110000110110000011011"; 411 | break; 412 | case 'f2l_1' : 413 | $mask = "000000000000011011000110110110111111000111111000111111"; 414 | break; 415 | case 'f2b' : 416 | $mask = "000000000000111111000101101101101101000111111000101101"; 417 | break; 418 | case 'line' : 419 | $mask = "000000000000000000000010010010010010000000000000010010"; 420 | break; 421 | case '2x2x2' : 422 | $mask = "000000000000110110000011011011011000000000000000000000"; 423 | break; 424 | case '2x2x3' : 425 | $mask = "000000000000110110000111111111111000000011011000000000"; 426 | break; 427 | } 428 | }else if($dim == 2){ 429 | switch($stage){ 430 | case 'fl' : 431 | $mask = "000000110011111100110011"; 432 | break; 433 | case 'll' : 434 | $mask = "111111001100000011001100"; 435 | break; 436 | case 'oll' : 437 | $mask = "111100000000111100000000"; 438 | break; 439 | } 440 | } 441 | 442 | // Apply alg to mask if defined 443 | if($mask && $st_rtn != ''){ 444 | require_once "cube_lib.php"; 445 | $mask = fcs_doperm($mask, fcs_format_alg($st_rtn), $dim); 446 | } 447 | 448 | // Apply mask to face def 449 | if($mask){ 450 | for($i = 0; $i < $dim * $dim * 6; $i++){ 451 | $facelets[$i] = $mask[$i] == 0 ? 452 | ($view == 'trans' ? ($using_cols ? 't' : $T) : 453 | ($using_cols ? 'l' : $N)) : $facelets[$i]; 454 | } 455 | } 456 | } 457 | 458 | // Retrieve alg def 459 | if(array_key_exists('alg', $_REQUEST) || array_key_exists('case', $_REQUEST) 460 | || array_key_exists('alg', $DEFAULTS) || array_key_exists('case', $DEFAULTS)){ 461 | require_once "cube_lib.php"; 462 | if(array_key_exists('alg', $_REQUEST)) $alg = $_REQUEST['alg']; else $alg = $DEFAULTS['alg']; 463 | if(array_key_exists('case', $_REQUEST)) $case = $_REQUEST['case']; else $case = $DEFAULTS['case']; 464 | $alg = fcs_format_alg(urldecode($alg)); 465 | $case = invert_alg(fcs_format_alg(urldecode($case))); 466 | // $facelets = facelet_cube(case_cube($alg), $dim, $facelets); // old 3x3 alg system 467 | $facelets = fcs_doperm($facelets, $case . ' ' . $alg, $dim); // new NxN facelet permute 468 | } 469 | 470 | // Retrieve arrow defn's 471 | if(array_key_exists('arw', $_REQUEST)){ 472 | $astr = preg_split('/,/', $_REQUEST['arw']); 473 | $i = 0; 474 | foreach($astr as $a){ 475 | $a_ = parse_arrow($a, $dim); 476 | if($a_) $arrows[$i++] = $a_; 477 | } 478 | } 479 | 480 | // Retrieve default arrow colour 481 | $ac = $GREY; 482 | if(array_key_exists('ac', $_REQUEST)){ 483 | $ac_ = parse_col($_REQUEST['ac']); 484 | if($ac_ && $ac_ != 't') $ac = $ac_; 485 | } 486 | 487 | // ---------------[ 3D Cube Generator properties ]--------------- 488 | 489 | // Outline width 490 | $OUTLINE_WIDTH = 0.94; 491 | 492 | // Stroke width 493 | $sw = 0; 494 | 495 | // Viewport 496 | $ox = -0.9; 497 | $oy = -0.9; 498 | $vw = 1.8; 499 | $vh = 1.8; 500 | 501 | // ------------------[ 3D Cube Generator ]----------------------- 502 | 503 | // Set up cube for OLL view if specified 504 | if($view == 'plan'){ 505 | $rtn = Array(Array(0, -90)); 506 | } 507 | 508 | // All cube face points 509 | $p = Array(); 510 | // Translation vector to centre the cube 511 | $t = Array(-$dim/2, -$dim/2, -$dim/2); 512 | // Translation vector to move the cube away from viewer 513 | $zpos = Array(0, 0, $dist); 514 | // Rotation vectors to track visibility of each face 515 | $rv = Array(Array(0, -1, 0), Array(1, 0, 0), Array(0, 0, -1), Array(0, 1, 0), Array(-1, 0, 0), Array(0, 0, 1)); 516 | for($fc = 0; $fc < 6; $fc++){ 517 | for($i = 0; $i <= $dim; $i++){ 518 | for($j = 0; $j <= $dim; $j++){ 519 | switch($fc){ 520 | case $U : $p[$fc][$i][$j] = Array( $i, 0, $dim - $j); break; 521 | case $R : $p[$fc][$i][$j] = Array( $dim, $j, $i); break; 522 | case $F : $p[$fc][$i][$j] = Array( $i, $j, 0); break; 523 | case $D : $p[$fc][$i][$j] = Array( $i, $dim, $j); break; 524 | case $L : $p[$fc][$i][$j] = Array( 0, $j, $dim - $i); break; 525 | case $B : $p[$fc][$i][$j] = Array($dim - $i, $j, $dim); break; 526 | } 527 | // Now scale and tranform point to ensure size/pos independent of dim 528 | $p[$fc][$i][$j] = translate($p[$fc][$i][$j], $t); 529 | $p[$fc][$i][$j] = scale($p[$fc][$i][$j], 1 / $dim); 530 | // Rotate cube as per perameter settings 531 | foreach($rtn as $rn){ 532 | $p[$fc][$i][$j] = rotate($p[$fc][$i][$j], $rn[0], M_PI * $rn[1]/180); 533 | } 534 | // Move cube away from viewer 535 | $p[$fc][$i][$j] = translate($p[$fc][$i][$j], $zpos); 536 | // Finally project the 3D points onto 2D 537 | $p[$fc][$i][$j] = project($p[$fc][$i][$j], $zpos[2]); 538 | } 539 | } 540 | // Rotate rotation vectors 541 | foreach($rtn as $rn){ 542 | $rv[$fc] = rotate($rv[$fc], $rn[0], M_PI * $rn[1]/180); 543 | } 544 | } 545 | 546 | // Sort render order (crappy bubble sort) 547 | $ro = Array(0, 1, 2, 3, 4, 5); 548 | for($i = 0; $i < 5; $i++){ for($j = 0; $j < 5; $j++){ 549 | if($rv[$ro[$j]][2] < $rv[$ro[$j+1]][2]){ 550 | $t = $ro[$j]; $ro[$j] = $ro[$j+1]; $ro[$j+1] = $t; } 551 | }} 552 | 553 | // Cube diagram SVG XML 554 | $cube = " 555 | 557 | 558 | \n"; 561 | 562 | // Draw background 563 | if($bg) $cube .= "\t\n"; 564 | 565 | // Transparancy background rendering 566 | if($co < 100){ 567 | // Create polygon for each background facelet (transparency only) 568 | $cube .= "\t\n"; 569 | for($ri = 0; $ri < 3; $ri++){ 570 | $cube .= facelet_svg($ro[$ri]); 571 | } 572 | $cube .= "\t\n"; 573 | 574 | // Create outline for each background face (transparency only) 575 | $cube .= "\t\n"; 576 | for($ri = 0; $ri < 3; $ri++) 577 | $cube .= outline_svg($ro[$ri]); 578 | $cube .= "\t\n"; 579 | } 580 | 581 | // Create outline for each visible face 582 | $cube .= "\t\n"; 583 | for($ri = 3; $ri < 6; $ri++){ 584 | if(face_visible($ro[$ri], $rv) || $co < 100) 585 | $cube .= outline_svg($ro[$ri]); 586 | } 587 | $cube .= "\t\n"; 588 | 589 | // Create polygon for each visible facelet 590 | $cube .= "\t\n"; 591 | for($ri = 3; $ri < 6; $ri++){ 592 | if(face_visible($ro[$ri], $rv) || $co < 100) 593 | $cube .= facelet_svg($ro[$ri]); 594 | } 595 | $cube .= "\t\n"; 596 | 597 | // Create OLL view guides 598 | if($view == 'plan'){ 599 | $cube .= "\t\n"; 600 | $toRender = Array($F, $L, $B, $R); 601 | foreach($toRender as $fc) 602 | $cube .= oll_svg($fc); 603 | $cube .= "\t\n"; 604 | } 605 | 606 | // Draw Arrows 607 | if(isset($arrows)){ 608 | $awidth = 0.12 / $dim; 609 | $cube .= "\t\n"; 610 | foreach($arrows as $i => $a){ 611 | $cube .= gen_arrow($i, $a[0], $a[1], $a[2], $a[4], array_key_exists(3, $a)?$a[3]:$ac); 612 | } 613 | $cube .= "\t\n"; 614 | } 615 | 616 | $cube .= "\n"; 617 | 618 | 619 | 620 | 621 | 622 | // Display cube 623 | if($DEBUG) echo $cube; 624 | else{ 625 | $img = $fmt != 'svg' ? convert($cube, $fmt, $size) : $cube; 626 | display_img($img, $fmt); 627 | 628 | // Cache image if enabled 629 | if($ENABLE_CACHE && !array_key_exists("nocache", $_REQUEST) && strlen($img) < $CACHE_IMG_SIZE_LIMIT){ 630 | $req = mysqli_real_escape_string($mysql_con, $_SERVER['QUERY_STRING']); 631 | $rfr = mysqli_real_escape_string($mysql_con, $_SERVER['HTTP_REFERER']); 632 | $hash = md5($req); 633 | $img = mysqli_real_escape_string($mysql_con, $img); 634 | mysqli_query($mysql_con, "INSERT INTO vcache(hash, fmt, req, rfr, rcount, img) ". 635 | "VALUES ('$hash', '$fmt', '$req', '$rfr', 1, '$img')"); 636 | // Disconnect from db 637 | mysqli_close(); 638 | } 639 | } 640 | } 641 | 642 | 643 | // -----------------[ User input functions ]---------------------- 644 | 645 | // Parse colour value 646 | function parse_col($col){ 647 | global $NAME_COL, $ABBR_COL; 648 | // As an abbriviation 649 | if(preg_match('/^[ndlswyrogbpmt]$/', $col)) 650 | return $ABBR_COL[$col]; 651 | // As a name 652 | if(array_key_exists($col, $NAME_COL)) 653 | return $NAME_COL[$col]; 654 | // As 12-bit colour 655 | if(preg_match('/^[0-9a-fA-F]{3}$/', $col)) 656 | return $col[0].$col[0].$col[1].$col[1].$col[2].$col[2]; 657 | // As 24-bit colour 658 | if(preg_match('/^[0-9a-fA-F]{6}$/', $col)) 659 | return $col; 660 | // Otherwise fail 661 | return null; 662 | } 663 | 664 | // Parse arrow definition 665 | function parse_arrow($str, $dim){ 666 | $parts = preg_split('/-/', $str); 667 | $fcodes = array('U' => 0, 'R' => 1, 'F' => 2, 'D' => 3, 'L' => 4, 'B' => 5); 668 | if(count($parts) == 0) return null; 669 | if(!preg_match_all('/([URFDLB])([0-9]+)/', $parts[0], $split) || count($split) < 2) return null; 670 | $arrow = array(); 671 | $arrow[4] = 1; 672 | for($i = 0; $i < 3; $i++){ 673 | if($i == 2 && count($split[1]) < 3){ 674 | $arrow[2] = null; 675 | break; 676 | } 677 | else $arrow[2][3] = 2; 678 | $arrow[$i][0] = $fcodes[$split[1][$i]]; 679 | $fn = $split[2][$i]; $fn = $fn >= $dim * $dim ? $dim * $dim - 1 : $fn; 680 | $arrow[$i][1] = $fn % $dim; 681 | $arrow[$i][2] = floor($fn / $dim); 682 | } 683 | // Parse remainder 684 | for($i = 1; $i < count($parts); $i++){ 685 | if(preg_match('/^i[0-9]+$/', $parts[$i]) && $arrow[2]){ 686 | $arrow[2][3] = substr($parts[$i],1) / 5; 687 | $arrow[2][3] = $arrow[2][3] > 10 ? 10 : $arrow[2][3]; // Var range = 0 to 50, default 10 688 | } 689 | else if(preg_match('/^s[0-9]+$/', $parts[$i])){ 690 | $arrow[4] = substr($parts[$i],1) / 10; 691 | $arrow[4] = $arrow[4] > 2 ? 2 : $arrow[4]; // Var range = 0 to 20, default 10 692 | } 693 | else{ 694 | $ac_ = parse_col($parts[$i]); 695 | if($ac_) $arrow[3] = $ac_; 696 | } 697 | } 698 | return $arrow; 699 | } 700 | 701 | // Insert space in default fd/fc variables 702 | function insert_space($in, $dim){ 703 | $out = ''; 704 | $dim *= $dim; 705 | for($i = 0; $i < 6; $i++){ 706 | $out .= substr($in, $dim * $i, $dim) . ' '; 707 | } 708 | return $out; 709 | } 710 | 711 | 712 | // -------------------[ 3D Geometry Functions ]-------------------- 713 | 714 | // Move point by translation vector 715 | function translate($p, $t){ 716 | $p[0] += $t[0]; 717 | $p[1] += $t[1]; 718 | $p[2] += $t[2]; 719 | return $p; 720 | } 721 | 722 | function scale($p, $f){ 723 | $p[0] *= $f; 724 | $p[1] *= $f; 725 | $p[2] *= $f; 726 | return $p; 727 | } 728 | 729 | // Scale point relative to position vector 730 | function trans_scale($p, $v, $f){ 731 | // Translate each facelet to cf 732 | $iv = Array(-$v[0], -$v[1], -$v[2]); 733 | return translate(scale(translate($p, $iv), $f), $v); 734 | } 735 | 736 | function rotate($p, $ax, $an){ 737 | $np = Array($p[0], $p[1], $p[2]); 738 | switch($ax){ 739 | case 0 : 740 | $np[2] = $p[2] * cos($an) - $p[1] * sin($an); 741 | $np[1] = $p[2] * sin($an) + $p[1] * cos($an); 742 | break; 743 | case 1 : 744 | $np[0] = $p[0] * cos($an) + $p[2] * sin($an); 745 | $np[2] = - $p[0] * sin($an) + $p[2] * cos($an); 746 | break; 747 | case 2 : 748 | $np[0] = $p[0] * cos($an) - $p[1] * sin($an); 749 | $np[1] = $p[0] * sin($an) + $p[1] * cos($an); 750 | break; 751 | } 752 | return $np; 753 | } 754 | 755 | // Project 3D points onto a 2D plane 756 | function project($p, $d){ 757 | return Array( 758 | $p[0] * $d / $p[2], 759 | $p[1] * $d / $p[2], 760 | $p[2] // Maintain z coordinate to allow use of rendering tricks 761 | ); 762 | } 763 | 764 | // Returns whether a face is visible 765 | function face_visible($face, $rv){ 766 | return $rv[$face][2] < -0.105; 767 | } 768 | 769 | 770 | 771 | 772 | // ---------------------------[ Rendering Functions ]---------------------------- 773 | 774 | // Returns svg for a cube outline 775 | function outline_svg($fc){ 776 | global $p, $dim, $cc, $OUTLINE_WIDTH; 777 | return "\t\t\n"; 782 | } 783 | 784 | // Returns svg for a faces facelets 785 | function facelet_svg($fc){ 786 | global $p, $dim; 787 | $svg = ''; 788 | for($i = 0; $i < $dim; $i++){ 789 | for($j = 0; $j < $dim; $j++){ 790 | // Find centre point of facelet 791 | $cf = Array(($p[$fc][$j ][$i ][0] + $p[$fc][$j+1][$i+1][0])/2, 792 | ($p[$fc][$j ][$i ][1] + $p[$fc][$j+1][$i+1][1])/2, 0); 793 | // Scale points in towards centre 794 | $p1 = trans_scale($p[$fc][$j ][$i ], $cf, 0.85); 795 | $p2 = trans_scale($p[$fc][$j+1][$i ], $cf, 0.85); 796 | $p3 = trans_scale($p[$fc][$j+1][$i+1], $cf, 0.85); 797 | $p4 = trans_scale($p[$fc][$j ][$i+1], $cf, 0.85); 798 | // Generate facelet polygon 799 | $svg .= gen_facelet($p1, $p2, $p3, $p4, $fc * $dim * $dim + $i * $dim + $j); 800 | } 801 | } 802 | return $svg; 803 | } 804 | 805 | // Renders the top rim of the R U L and B faces out from side of cube 806 | function oll_svg($fc){ 807 | global $p, $dim, $rv; 808 | $svg = ''; 809 | // Translation vector, to move faces out 810 | $tv1 = scale($rv[$fc], 0.00); 811 | $tv2 = scale($rv[$fc], 0.20); 812 | $i = 0; 813 | for($j = 0; $j < $dim; $j++){ 814 | // Find centre point of facelet 815 | $cf = Array(($p[$fc][$j ][$i ][0] + $p[$fc][$j+1][$i+1][0])/2, 816 | ($p[$fc][$j ][$i ][1] + $p[$fc][$j+1][$i+1][1])/2, 0); 817 | // Scale points in towards centre and skew 818 | $p1 = translate(trans_scale($p[$fc][$j ][$i ], $cf, 0.94), $tv1); 819 | $p2 = translate(trans_scale($p[$fc][$j+1][$i ], $cf, 0.94), $tv1); 820 | $p3 = translate(trans_scale($p[$fc][$j+1][$i+1], $cf, 0.94), $tv2); 821 | $p4 = translate(trans_scale($p[$fc][$j ][$i+1], $cf, 0.94), $tv2); 822 | // Generate facelet polygon 823 | $svg .= gen_facelet($p1, $p2, $p3, $p4, $fc * $dim * $dim + $i * $dim + $j); 824 | 825 | } 826 | return $svg; 827 | } 828 | 829 | /** Generates a polygon SVG tag for cube facelets */ 830 | function gen_facelet($p1, $p2, $p3, $p4, $seq){ 831 | global $ABBR_COL, $facelets, $scheme, $using_cols, $cc, $T; 832 | $fcol = $using_cols ? ($facelets[$seq] == 't' ? 't' : $ABBR_COL[$facelets[$seq]]) 833 | : ($facelets[$seq] == $T ? 't' : $scheme[$facelets[$seq]]); 834 | return "\t\t\n"; 841 | } 842 | 843 | // Generates svg for an arrow pointing from sticker s1 to s2 844 | function gen_arrow($id, $s1, $s2, $sv, $sc, $col){ 845 | global $p, $dim; 846 | if($col == 't') return; 847 | // Find centre point of each facelet 848 | $p1 = Array(($p[$s1[0]][$s1[1]][$s1[2]][0] + $p[$s1[0]][$s1[1]+1][$s1[2]+1][0])/2, 849 | ($p[$s1[0]][$s1[1]][$s1[2]][1] + $p[$s1[0]][$s1[1]+1][$s1[2]+1][1])/2, 0); 850 | $p2 = Array(($p[$s2[0]][$s2[1]][$s2[2]][0] + $p[$s2[0]][$s2[1]+1][$s2[2]+1][0])/2, 851 | ($p[$s2[0]][$s2[1]][$s2[2]][1] + $p[$s2[0]][$s2[1]+1][$s2[2]+1][1])/2, 0); 852 | // Find midpoint between p1 and p2 853 | $cp = Array(($p1[0] + $p2[0])/2, ($p1[1] + $p2[1])/2, 0); 854 | // Shorten arrows towards midpoint according to config 855 | $p1 = trans_scale($p1, $cp, $sc); 856 | $p2 = trans_scale($p2, $cp, $sc); 857 | if($sv){ 858 | $pv = Array(($p[$sv[0]][$sv[1]][$sv[2]][0] + $p[$sv[0]][$sv[1]+1][$sv[2]+1][0])/2, 859 | ($p[$sv[0]][$sv[1]][$sv[2]][1] + $p[$sv[0]][$sv[1]+1][$sv[2]+1][1])/2, 0); 860 | // Project via point double dist from centre point 861 | $pv = trans_scale($pv, $cp, $sv[3]); 862 | } 863 | // Calculate arrow rotation 864 | $p_ = $sv ? $pv : $p1; 865 | $rt = $p_[1] > $p2[1] ? 270 : 90; 866 | if($p2[0]-$p_[0] != 0){ 867 | $rt = rad2deg(atan(($p2[1]-($p_[1]))/($p2[0]-$p_[0]))); 868 | $rt = ($p_[0] > $p2[0]) ? $rt + 180 : $rt; 869 | } 870 | return ' 872 | '."\n"; 875 | } 876 | 877 | /** Converts svg into given format */ 878 | function convert($svg, $fmt, $size) { 879 | global $CONVERT; 880 | $opts = gen_image_opts($fmt, $size, "svg:-", "$fmt:-"); 881 | $descriptorspec = array(0 => array("pipe", "r"), 1 => array("pipe", "w")); 882 | $convert = proc_open("$CONVERT $opts", $descriptorspec, $pipes); 883 | fwrite($pipes[0], $svg); 884 | fclose($pipes[0]); 885 | $img = null; 886 | while(!feof($pipes[1])) { 887 | $img .= fread($pipes[1], 1024); 888 | } 889 | fclose($pipes[1]); 890 | proc_close($convert); 891 | return $img; 892 | } 893 | 894 | /** Alternative version using files rather than pipes, 895 | not desired because of collision possibilities.. */ 896 | function convert_file($svg, $fmt, $size) { 897 | global $CONVERT; 898 | $svgfile = fopen("/tmp/visualcube.svg", 'w'); 899 | fwrite($svgfile, $svg); 900 | fclose($svgfile); 901 | $opts = gen_image_opts($fmt, $size, '/tmp/visualcube.svg', "/tmp/visualcube.$fmt"); 902 | $rsvg = exec("$CONVERT $opts"); 903 | $imgfile = fopen("/tmp/visualcube.$fmt", 'r'); 904 | $img = null; 905 | while($imgfile and !feof($imgfile)) { 906 | $img .= fread($imgfile, 1024); 907 | } 908 | fclose($imgfile); 909 | return $img; 910 | } 911 | 912 | /** Generate ImageMagick options depending on format */ 913 | function gen_image_opts($fmt, $size, $infile, $outfile){ 914 | $inopts = ' -density 600 -resize '.$size.'x'.$size; 915 | $outopts = ' -channel RGBA -alpha set'; 916 | // $opts .= '+label "Generated by VisualCube"'; 917 | // $opts .= ' -comment "Generated by VisualCube"'; 918 | // $opts .= ' -caption "Generated by VisualCube"'; 919 | // $opts = "-gaussian 1"; 920 | switch($fmt){ 921 | case 'png' : $inopts .= " -background none"; $outopts .= " -quality 100 -define png:format=png32"; 922 | break; 923 | case 'gif' : $inopts .= " -background none"; 924 | break; 925 | case 'ico' : $inopts .= " -background none"; 926 | break; 927 | case 'jpg' : $outopts .= " -quality 90"; 928 | break; 929 | 930 | } 931 | return "$inopts $infile $outopts $outfile"; 932 | } 933 | 934 | /** Sends image to browser */ 935 | function display_img($img, $fmt){ 936 | $mime = $fmt; 937 | switch($fmt){ 938 | case 'jpe' : 939 | case 'jpg' : $mime = 'jpeg'; break; 940 | case 'svg' : $mime = 'svg+xml'; break; 941 | case 'ico' : $mime = 'vnd.microsoft.icon'; break; 942 | } 943 | header("Content-type: image/$mime"); 944 | // header("Content-Length: " . filesize($img) ."; "); 945 | echo $img; 946 | } 947 | 948 | 949 | 950 | 951 | 952 | // -----------------------------[ DB Access Functions ]-------------------------- 953 | 954 | // Return result of sql query as array 955 | function get_arrays($mysql_con, $query){ 956 | $result = mysqli_query($mysql_con, $query); 957 | $count = mysqli_num_rows($result); 958 | if($count <= 0) return null; 959 | $ary = Array($count); 960 | $i = 0; 961 | while($record = mysqli_fetch_array($result, MYSQLI_ASSOC)){ 962 | $ary[$i] = $record; 963 | $i++; 964 | } 965 | return $ary; 966 | } 967 | ?> 968 | -------------------------------------------------------------------------------- /visualcube_0.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cride5/visualcube/5e3d38a534375adf2a326b99941f01999199163d/visualcube_0.gif -------------------------------------------------------------------------------- /visualcube_1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cride5/visualcube/5e3d38a534375adf2a326b99941f01999199163d/visualcube_1.gif -------------------------------------------------------------------------------- /visualcube_2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cride5/visualcube/5e3d38a534375adf2a326b99941f01999199163d/visualcube_2.gif -------------------------------------------------------------------------------- /visualcube_3.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cride5/visualcube/5e3d38a534375adf2a326b99941f01999199163d/visualcube_3.gif -------------------------------------------------------------------------------- /visualcube_4.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cride5/visualcube/5e3d38a534375adf2a326b99941f01999199163d/visualcube_4.gif -------------------------------------------------------------------------------- /visualcube_api.php: -------------------------------------------------------------------------------- 1 | '."\n". 12 | ''."\n"; 14 | 15 | $CUBE_CRIDER="http://cube.crider.co.uk/"; 16 | 17 | // Start page render 18 | echo $HTML_DEF; 19 | ?> 20 | 21 | 22 | VisualCube (v<?php echo $VERSION; ?>) 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 46 | 103 | 104 | 105 | 118 |
119 | 120 | Valid XHTML 1.0 Strict 121 | 122 |

VisualCube

123 | Generate custom Rubik's cube visualisations from your browser address bar. 124 |

125 |
126 |
127 |

Instructions

128 | Simply point your browser to visualcube.php to create a cube image.
129 | A range of parameters can be set to customise the cube visualisation.
130 | Click the link below for an example:

131 |           132 | cube.crider.co.uk/visualcube.php?fmt=&size=150&pzl=2&alg=R2F2R2 133 |


134 |

Examples

135 | The following images were generated by VisualCube. 136 |

137 |
138 | 139 | Example 0 140 | 141 | Example 1 142 | 143 | Example 2 144 | 145 | Example3 146 | 147 | Example4 148 |
149 | Click each cube to see how it was generated.. 150 |


151 |

Features

152 |
    153 |
  • Fully 3D cube visualisation
    • 154 |
  • Cube dimensions from 1x1x1 to NxNxN
    • 155 |
  • Algorithm support
    • 156 |
  • Complete orientation control
    • 157 |
  • Multiple image formats
    • 158 |
  • Custom image size
    • 159 |
  • Cube and facelet transparency
    • 160 |
  • Custom colour schemes
    • 161 |
  • Custom background colour
    • 162 |
  • Image caching for speedy access
    • 163 |
  • Cookie configurable variables
    • 164 |
165 |
166 |

To Do

167 |
168 | The following features/bug fixes are planned for the future (ordered by priority). 169 |
    170 |
  • More special views added to the 'view' variable (permutation arrows for example)
    • 171 |
  • Visualisation of other puzzles inc square-1, megaminx and pyraminx
    • 172 |
173 |

174 |
175 |

Source Code

176 |
The source code for this script is available under the GNU Lesser General Public License at 177 | github.com/Cride5/visualcube.
178 |

179 |

Parameters

180 | 181 | 182 | 183 | 186 | 187 | 188 | 189 | 190 | 192 | 193 | 196 | 199 | 200 | 201 | 204 | 205 | 206 | 208 | 209 | 212 | 213 | 215 | 224 | 225 | 227 | 232 | 233 | 234 | 239 | 248 | 252 | 253 | 254 | 255 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | 268 | 269 | 288 | 292 | 294 |
VariableDescriptionValue RangeDefaultComment
.script extension .png | .gif | .jpg | .svg | .tiff | .ico .The extension used in the script url dictates the format of the image generated. For example: 184 | visiting /visualcube.jpg 185 | will create a jpeg image.
fmtImage Format png | gif | jpg | svg | tiff | ico Used as an alternative to using an image extension as above.
pzlPuzzle Type1 to Values from N=(1 to ) represent an NxNxN cube. Currently only regular cubes are modelled
sizeSize of generated image0 to 1024 191 | Images produced are square, so size specifies both width and height of the final image in pixels.
viewSpecial Viewplan|trans The view parameter allows special views to facilitate interpretation of different case aspects. 194 |
plan rotates cube to expose U face, while showing the sides of the top layer
195 | trans sets the cube base colour to transparent, and hides any masked or undefined faces
stageStage Mask ( fl | f2l | ll | cll | ell | oll | ocll | oell | coll | ocell | wv | 197 | vh | els | cls | cmll | cross | f2l_3 | f2l_2 | f2l_sm | f2l_1 | f2b | line | 2x2x2 | 2x2x3 )-?[xyz2']* 198 |  Sets parts of the cube to be masked from being coloured. The stage identifier is optionally followed by a rotation algorithm. For example: stage=cross-x2 would rotate the cross mask so that the cross appears on the U-layer rather than the D-layer
rRotation Sequence([xyz]-?[0-9][0-9]?[0-9]?)+Each entry in the sequence is an axis (x, y or z), followed by the 202 | number of degrees to rotate in a clockwise direction. Negative values are permitted. 203 | Any number of rotations is possible.
State Definitions
algAlgorithm to apply[UDLRFBudlrfbMESxyz'2 ]* The system applies the algorithm to the cube and displays the resulting state.

207 | NOTE: Currently unavailable for 4x4 cubes or above
caseAlgorithm to solve case[UDLRFBudlrfbMESxyz'2 ]* The system displays the cube state which is solved by applying the algorithm 210 | (algorithm inverse).

211 | NOTE: Currently unavailable for 4x4 cubes or above
fdFacelet Definition[udlrfbnot]*Defines the cube state in terms of facelet positions. 216 | u stands for a 'U' facelet (and likewise with rfdlb). 217 | Defining a cube state using this method means the cube will be coloured 218 | according to the scheme defined by the sch variable. 219 | Three special characters are used to indicate the following:
220 | n: This is a blank face (coloured grey)
221 | o: This is an 'oriented' face (coloured silver)
222 | t: This is a transparent face, and will not appear on the cube 223 |
fcFacelet Colours[ndlswyrobgmpt]*Defines the cube state in terms of facelet colours, 228 | as an alternative to using fd. fc 229 | takes precedence over fd if both are defined.

230 | See the 'sch' variable below for an explanation of the colour codes. 231 |
Cube Style
schColour Scheme[ndlswyrobgmp]*6

OR

235 | Comma separated list containing 6x one of:
236 | black | dgrey | grey | silver | white | yellow | red | orange | blue 237 | | green | purple | pink | [0-9a-fA-F]*3 | [0-9a-fA-F]*6 238 | 		The order of the colours specified represent the faces in this order:

240 | U R F D L B 241 |

The letters used in shorthand notation map to the generic 242 | face colours as follows: n=black (noir), d=dark grey, l=light grey, 243 | s=silver (lighter grey), w=white, y=yellow, r=red, o=orange, b=blue, g=green, 244 | m=purple (magenta), p=pink, t=transparent

245 | Where longhand notation is used, 3 or 6-digit hex codes can be used to specify 246 | the exact colour. for example C80000 would be a dark red colour. 247 |
bgBackground Colour of image[ndlswyrobgmpt]

OR

249 | black | dgrey | grey | silver | white | yellow | red | orange | blue 250 | | green | purple | pink | [0-9a-fA-F]*3 | [0-9a-fA-F]*6 251 | 		The value t represents transparent, and is only valid for png and gif images.
ccCube Coloursee aboveThis is the cube's base colour.
coCube Opacity0 to 99Setting this value causes the base cube to be transparent. 256 | It means facelets at the back of the cube will also be rendered. 257 | A value of 0 gives complete transparency.
foFacelet Opacity0 to 99Setting this value causes the facelets to be rendered with transparency.
distProjection Distance1 to 100Controls the distance of the cube from the perspective of the viewer.
Added Features
arwArrow DefinitionComma separated list in the form:

265 | <a_from><a_to>(<a_via>)?(-i[0-9+])?(-s[0-9+])?(-<colour>)?

266 | Where <a_x> is: [URFDLB][0-9]+

267 | And: <colour> is as defined in the 'sch' variable.		-i10-s10Defines a list of arrows to be drawn on the cube.

270 | Each arrow is defined with a minimum of two sticker identifiers to indicate 271 | where it should be drawn from and to. The optional third sticker identifier 272 | indicates which sticker it should pass through if a curved arrow is to be drawn. 273 | Arrows may be scaled so that they fall short, or past the centre of each facelet 274 | by specifying the s (scale) parameter after a dash. 275 | Where curved arrows are drawn the degree to which the arrow deviates from a straight 276 | path can be specified via the i (influence) parameter. 277 | Arrows may also optionally be assigned individual colours, by using a - 278 | followed by a colour code. 279 |

Example:   arw=U0U2,U2U8,U8U0,R6R2R0-s8-i5-yellow 280 |

281 | The above example draws 4 arrows. The first three use default colour and scale 282 | and point to stickers on the U-face. The fourth arrow 283 | points from sticker #6 to sticker #2 on the R-face, and is curved 284 | so that it passes through sticker #0. The arrow is slightly shortened to 8/10 285 | of its full length, and the influence of the pass through sticker in generating 286 | the curve is set to 5/10. 287 |
acDefault Arrow Colour[ndlswyrobgmp]

OR

289 | black | dgrey | grey | silver | white | yellow | red | orange | blue 290 | | green | purple | pink | [0-9a-fA-F]*3 | [0-9a-fA-F]*6 291 | 		greyArrows will be this colour by default, unless overridden by a 293 | colour specified for each arrow in the arw variable.
295 |

296 |

Cookie Configuration

297 | The desired values for cookie configurable variables can be set below.
298 | Refer to the table above for acceptable values. 299 | 315 |
316 | 320 | 321 | 322 | -------------------------------------------------------------------------------- /visualcube_config.php: -------------------------------------------------------------------------------- 1 | 'svg', 13 | 'pzl' => '3', 14 | 'size' => '128', 15 | 'view' => '', 16 | 'stage' => '', 17 | 'r' => 'y45x-34', 18 | 'alg' => '', 19 | 'case' => '', 20 | 'fd' => '', 21 | 'fc' => '', 22 | 'sch' => 'yrbwog', 23 | 'bg' => 'white', 24 | 'cc' => 'black', 25 | 'co' => '100', 26 | 'fo' => '100', 27 | 'dist' => '5', 28 | ); 29 | 30 | // Location of ImageMagick's 'convert' binary. 31 | // NOTE: if the $PATH variable is set up correctly using just 'convert' is sufficient 32 | $CONVERT="convert"; 33 | 34 | 35 | // -------------[ Cache related configuration ]--------------- 36 | 37 | 38 | // Whether image caching is enabled. NOTE: if enabled a cron 39 | // job will need to be set up to prune the database 40 | $ENABLE_CACHE = false; 41 | // Database Configuration (for image caching) 42 | $DB_HOST="localhost"; 43 | $DB_NAME="DATABASE_NAME"; 44 | $DB_USERNAME="DATABASE_USERNAME"; 45 | $DB_PASSWORD="DATABASE_PASSWORD"; 46 | // Maximum size of image to be cached 47 | $CACHE_IMG_SIZE_LIMIT = 10000; // 10Kb 48 | 49 | -------------------------------------------------------------------------------- /visualcube_dbprune.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # Script to prune virtualcube image cache, to be run weekly 4 | 5 | # Prune database by removing all entries which have been accessed less than 1 times 6 | mysql -u DB_USER --safe-updates=0 --password="DB_PASS" DB_NAME -e "DELETE FROM vcache WHERE rcount < 1" 7 | 8 | # Reset all existing entrys to 0 9 | mysql -u DB_USER --safe-updates=0 --password="DB_PASS" DB_NAME -e "UPDATE vcache SET rcount=0" 10 | 11 | # Query to display db contents 12 | #mysql -u DB_USER --password="DB_PASS" DB_NAME -e "SELECT hash, fmt, req, rfr, rcount, OCTET_LENGTH(img) FROM vcache" 13 | 14 | # This crontab line will run it at 4 am every Monday 15 | #00 4 * * Mon /path/to/visualcube_dbprune.sh "Prune visualcube image cache" 16 | # To install crontab on multi-user system place the line in a file and then run: 17 | # crontab 18 | 19 | 20 | --------------------------------------------------------------------------------