diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..04a6e8d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +generated/* \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 85e8d23..375e626 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,52 @@ # MAGE :: PHP MySQL Admin Panel Generator +Available for Python also: [Python Mage](https://github.com/housamz/python-mysql-admin-panel-generator) + PHP MySQL Admin Panel Generator (MAGE), a PHP tool that helps you create a PHP Admin Panel for any MySQL database in seconds. -Mage is not PHPMyAdmin, it doesn't contain all your databases. It physicall creates an admin panel for a database. +Mage is not PHPMyAdmin; it doesn't contain all your databases. It physically creates an admin panel for a database. -A suggested usecase for the tool is to create a fast admin panel for a PHP / MySQL project that you're working on in seconds, and then you can tweak it before delivering that. +A suggested use-case for the tool would be creating an admin panel for a PHP / MySQL project in seconds, and then you can tweak it before delivery. You may use this tool for charity or school projects, for commercial use, please contact me. +### Name +MAGE is derived from `M`ySql `A`dmin panel `GE`nerator. +Mage (meɪdʒ): a magician or learned person. + ### Disclaimer: Always backup your database. ## Instructions: -1- Start by providing your MySQL Server Info, then click Next Step button. -![Server info](images/1.png) - -2- The tool will scan the server for available databases and list them in a dropdown menu, select the database that you want and then click "Generate Admin Panel" button -![Second Step](images/2.png) +***Note: You need to make sure that you have `php-mysql` package that connects PHP with MySQL, and that you change the `generated` directory permissions to be 777.*** -3- After a few seconds, you'll get a success message, with a link to the newly created admin panel, and a report of all the operations that were done. -![Success Message](images/3.png) - -4- Click the link to the admin panel. You have to sign in using "admin" as an email and a password. -![Sign in](images/4.png) - ---- +| Step | Thumb | Instructions | +| :--: |:----------------------------------------------------------------------:| :------------ | +| 1 | | Start by providing your MySQL Server Info, then click Next Step button. | +| 2 | | The tool will scan the server for available databases and list them in a dropdown menu, select the database that you want, then check if you need full HTML editor or not, and then click "Generate Admin Panel" button | +| 3 | | After a few seconds, you'll get a success message, with a link to the newly created admin panel, and a report of all the operations that were done. | +| 4 | | Click the link to the admin panel. You have to sign in using "admin" as an email and a password. | You'll get a clean bootstrap interface to control the website, check below screenshots: -![Admin Panel 1](images/5.png) + + + + +## Notes +MAGE handles data using `htmlentities` as well as `addslashes` to prevent XSS attacks. This means that any HTML tags, especially those generated by the CKEditor, will be encoded. +If you want to display the original HTML code use `html_entity_decode()` around that specific field. +If you don't need HTML tags at all, you can disable CKEditor by unchecking the checkbox before clicking "Generate Admin Panel". + +## Debugging: +#### Nothing happens when you provide credentials on home page +You need to install `php-mysql` package, the following installs the latest version. +```bash +sudo apt install php-mysql +service apache2 restart +``` + +#### Nothing happens when I click Generate button +Change the `generated` directory permission to 777 +```bash +chmod 777 generated +``` + ---- -![Admin Panel 2](images/6.png) ---- -![Admin Panel 3](images/7.png) \ No newline at end of file diff --git a/handler.php b/handler.php index 25c0d1f..0518e97 100755 --- a/handler.php +++ b/handler.php @@ -1,19 +1,18 @@ 'error','message'=> 'Could not connect: ' . mysql_error()))); + die(json_encode(array('status' => 'error','message'=> 'Could not connect: ' . mysqli_error($link)))); } // if the action is to connect, we request all databases - if($action == "connect"){ - - $res = mysql_query("SHOW DATABASES"); + if($action == "connect") { + $result = ''; + $res = mysqli_query($link, "SHOW DATABASES"); if (!$res) { - die(json_encode(array('status' => 'error','message'=> 'Listing databases failed: ' . mysql_error()))); + die(json_encode(array('status' => 'error','message'=> 'Listing databases failed: ' . mysqli_error($link)))); } - - while ($row = mysql_fetch_assoc($res)) { + while ($row = mysqli_fetch_assoc($res)) { $result .= ""; } - if(!$result){ + if(!$result) { echo json_encode(array('status' => 'error','message'=> 'Error in data collection')); } else { echo json_encode(array('status' => 'success','result'=> $result)); @@ -70,7 +69,7 @@ function random_glyphicon(){ } // process starts if the action is to generate the admin panel - else if($action == "generate") { + else if ($action == "generate") { // get the database name $database = $_POST["database"]; @@ -79,35 +78,35 @@ function random_glyphicon(){ $message = "The operations that were performed are: - +

Created using MAGE ♥

Visit Project @@ -478,9 +476,7 @@ function navConfirm(loc) { } - } else { - - echo json_encode(array('status' => 'error','message'=> 'Unknown error occured')); + echo json_encode(array('status' => 'error','message'=> 'Unknown error occurred')); } -?> \ No newline at end of file +?> diff --git a/images/2.png b/images/2.png index ac8fc3b..5bd56d7 100644 Binary files a/images/2.png and b/images/2.png differ diff --git a/index.php b/index.php index c19023d..392aa96 100644 --- a/index.php +++ b/index.php @@ -8,12 +8,9 @@ MAGE :: MySQL Admin Generator - - - - +