diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9da198a --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# Email Address Exporter plugin for Zen Cart + +Add-On: Email Address Exporter Admin Tool +Designed for: Zen Cart v1.5.8+ + +Created by: DrByte +Some revisions added by: Swifty8078, Ooba_Scott, That Software Guy + +Donations: Please support Zen Cart! paypal@zen-cart.com - Thank you! +=========================================================== + +NOTES: +This add-on was created to allow quick and easy exporting of email addresses from your Zen Cart shop. + +This is especially useful if you are needing to manage mailing lists and/or send newsletters or mass-emailings from your personal computer. +One great tool to use this with is GroupMail, which you can get a free copy of here: https://www.shareasale.com/r.cfm?B=3937&U=151719&M=1465 + +As to export formats, you can choose from CSV, TXT (tab-delimited), XML, or HTML formats. + +You can select any of the audiences available in your cart, using the pulldown menu provided. +The most common audience would be Newsletter recipients. + +=========================================================== + +INSTALLATION: +Upload all files from the zc_plugins directory to the zc_plugins directory on your server, retaining folder structures. + +In your Admin permissions panel, grant access to appropriate users using the Admin Access Management screen. + +=========================================================== + +USE: +To use, just log into the admin area, click on "Tools", and click on "Export Email Addresses". + +=========================================================== + +HISTORY: +March 10/05 - Initial Release +April 15/05 - Added XML format +May 11/05 - Added Save To File format, and tweaked streaming methods slightly +July 2012 - updated for Zen Cart v1.5.0 +Sept 2012 - DrByte updated for Zen Cart v1.5.1, and to add ability to easily add more fields to the output, along with THREE-STEPS INSTRUCTIONS in the code on how to do it. +Nov 2013 - DrByte added a fix to prevent a database error from occurring when you forget to choose an export option +Dec 2013 - DrByte removed debug code left in previous update. +Dec 2014 - tidying +Aug 2017 - included telephone and company fields in export (requires them to be in the db query that feeds the exporter though). Also forced limits on filenames used for exporting. +misc updates +May 2024 - converted to encapsulated plugin (also removed Save To File On Server feature, since most people simply download directly anyway). diff --git a/zc_plugins/EmailAddressExporter/README.md b/zc_plugins/EmailAddressExporter/README.md new file mode 100644 index 0000000..9da198a --- /dev/null +++ b/zc_plugins/EmailAddressExporter/README.md @@ -0,0 +1,48 @@ +# Email Address Exporter plugin for Zen Cart + +Add-On: Email Address Exporter Admin Tool +Designed for: Zen Cart v1.5.8+ + +Created by: DrByte +Some revisions added by: Swifty8078, Ooba_Scott, That Software Guy + +Donations: Please support Zen Cart! paypal@zen-cart.com - Thank you! +=========================================================== + +NOTES: +This add-on was created to allow quick and easy exporting of email addresses from your Zen Cart shop. + +This is especially useful if you are needing to manage mailing lists and/or send newsletters or mass-emailings from your personal computer. +One great tool to use this with is GroupMail, which you can get a free copy of here: https://www.shareasale.com/r.cfm?B=3937&U=151719&M=1465 + +As to export formats, you can choose from CSV, TXT (tab-delimited), XML, or HTML formats. + +You can select any of the audiences available in your cart, using the pulldown menu provided. +The most common audience would be Newsletter recipients. + +=========================================================== + +INSTALLATION: +Upload all files from the zc_plugins directory to the zc_plugins directory on your server, retaining folder structures. + +In your Admin permissions panel, grant access to appropriate users using the Admin Access Management screen. + +=========================================================== + +USE: +To use, just log into the admin area, click on "Tools", and click on "Export Email Addresses". + +=========================================================== + +HISTORY: +March 10/05 - Initial Release +April 15/05 - Added XML format +May 11/05 - Added Save To File format, and tweaked streaming methods slightly +July 2012 - updated for Zen Cart v1.5.0 +Sept 2012 - DrByte updated for Zen Cart v1.5.1, and to add ability to easily add more fields to the output, along with THREE-STEPS INSTRUCTIONS in the code on how to do it. +Nov 2013 - DrByte added a fix to prevent a database error from occurring when you forget to choose an export option +Dec 2013 - DrByte removed debug code left in previous update. +Dec 2014 - tidying +Aug 2017 - included telephone and company fields in export (requires them to be in the db query that feeds the exporter though). Also forced limits on filenames used for exporting. +misc updates +May 2024 - converted to encapsulated plugin (also removed Save To File On Server feature, since most people simply download directly anyway). diff --git a/zc_plugins/EmailAddressExporter/v2.0.0/Installer/ScriptedInstaller.php b/zc_plugins/EmailAddressExporter/v2.0.0/Installer/ScriptedInstaller.php new file mode 100644 index 0000000..5f26589 --- /dev/null +++ b/zc_plugins/EmailAddressExporter/v2.0.0/Installer/ScriptedInstaller.php @@ -0,0 +1,39 @@ +dbConn->Execute("SELECT query_string FROM " . TABLE_QUERY_BUILDER . " WHERE query_name = 'All Customers'"); + if ($result->fields['query_string'] === 'SELECT customers_email_address, customers_firstname, customers_lastname FROM TABLE_CUSTOMERS ORDER BY customers_lastname, customers_firstname, customers_email_address') { + $this->dbConn->Execute( + "UPDATE " . TABLE_QUERY_BUILDER . " SET query_string='select customers_firstname, customers_lastname, customers_email_address, c.*, a.* from TABLE_CUSTOMERS c, TABLE_ADDRESS_BOOK a WHERE c.customers_id = a.customers_id AND c.customers_default_address_id = a.address_book_id ORDER BY customers_lastname, customers_firstname, customers_email_address' + WHERE query_name = 'All Customers'" + ); + } + $result = $this->dbConn->Execute("SELECT query_string FROM " . TABLE_QUERY_BUILDER . " WHERE query_name = 'All Newsletter Subscribers'"); + if ($result->fields['query_string'] === "SELECT customers_firstname, customers_lastname, customers_email_address FROM TABLE_CUSTOMERS WHERE customers_newsletter = '1'") { + $this->dbConn->Execute( + "UPDATE " . TABLE_QUERY_BUILDER . " SET query_string='select customers_firstname, customers_lastname, customers_email_address, c.*, a.* from TABLE_CUSTOMERS c, TABLE_ADDRESS_BOOK a WHERE c.customers_id = a.customers_id AND c.customers_default_address_id = a.address_book_id AND customers_newsletter = 1' + WHERE query_name = 'All Newsletter Subscribers'" + ); + } + } + + protected function executeUninstall(): void + { + zen_deregister_admin_pages(['emailExport']); + } +} diff --git a/zc_plugins/EmailAddressExporter/v2.0.0/admin/emails_export.php b/zc_plugins/EmailAddressExporter/v2.0.0/admin/emails_export.php new file mode 100755 index 0000000..3c21309 --- /dev/null +++ b/zc_plugins/EmailAddressExporter/v2.0.0/admin/emails_export.php @@ -0,0 +1,276 @@ + '0', 'text' => 'CSV']; +$available_export_formats[1] = ['id' => '1', 'text' => 'TXT']; +$available_export_formats[2] = ['id' => '2', 'text' => 'HTML']; +$available_export_formats[3] = ['id' => '3', 'text' => 'XML']; +$save_to_file_checked = !empty($_POST['savetofile']) ? $_POST['savetofile'] : 0; + +$post_format = !empty($_POST['format']) ? $_POST['format'] : 1; +$format = $available_export_formats[$post_format]['text']; +$is_attachment = ($format === "CSV" || $format === "TXT" || $format === "XML"); + +$file = $_POST['filename'] ?? 'email_addresses.txt'; +if (!preg_match('/.*\.(csv|txt|html?|xml)$/', $file)) { + $file .= '.txt'; +} + +if (!empty($_POST['audience_selected'])) { + $query_name = $_POST['audience_selected']; + if (is_array($_POST['audience_selected'])) { + $query_name = $_POST['audience_selected']['text']; + } +} +if (empty($query_name)) { + $messageStack->add(ERROR_PLEASE_SELECT_AUDIENCE, 'error'); + $action = ''; +} + + +if ($action === 'save') { + global $db; + + if ($format === 'CSV') { + $FIELDSTART = '"'; + $FIELDEND = '"'; + $FIELDSEPARATOR = ','; + $LINESTART = ''; + $LINEBREAK = "\n"; + } + if ($format === 'TXT') { + $FIELDSTART = ''; + $FIELDEND = ''; + $FIELDSEPARATOR = "\t"; + $LINESTART = ''; + $LINEBREAK = "\n"; + } + if ($format === 'HTML') { + $FIELDSTART = ''; + $FIELDEND = ''; + $FIELDSEPARATOR = ""; + $LINESTART = ""; + $LINEBREAK = "" . $NL; + } + + /** + * CUSTOMIZATION STEP 1: + * 1. You must edit (or add to) the queries in the query_builder table if you want to add more fields to the extracted data. + * Look up your query_name (since this matches the pulldown in your admin), and update the query_string with the correct updated SQL query. + * Once the query in query_builder has been updated and tested, the following section of code will automatically + * bring in the right data for use in later steps. + */ + $audience_select = get_audience_sql_query($query_name, 'newsletters'); + if (empty($audience_select['query_string'])) { + $messageStack->add_session("No such query.", 'error'); + zen_redirect(zen_href_link(FILENAME_EMAIL_EXPORT)); + } + + zen_set_time_limit(600); + + $query_string = $audience_select['query_string']; + $audience = $db->Execute($query_string); + $records = $audience->RecordCount(); + $exporter_output = ''; + if ($records === 0) { + $messageStack->add_session("No Records Found.", 'error'); + } else { //process records + $i = 0; + + // make a tag if HTML output + if ($format === "HTML") { + $exporter_output .= '
' . $NL; + } + + /** + * CUSTOMIZATION STEP 2: + * 2. You must add your field name to this list. + * Notice how head heading here involves two lines: FIELDSTART, then the heading, then FIELDEND, followed by line for the FIELDSEPARATOR if it's not the last field being output. + * Be sure to follow the same pattern. + * Best to only use letters/numbers and underscores. No other punctuation. + */ + + // add column headers if CSV or HTML format + if ($format === "CSV" || $format === "HTML") { + $exporter_output .= $LINESTART; + $exporter_output .= $FIELDSTART . "customers_email_address" . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . "customers_firstname" . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . "customers_lastname" . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . "company_name" . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . "customers_telephone" . $FIELDEND; + $exporter_output .= $LINEBREAK; + } + // headers - XML + if ($format === "XML") { + $exporter_output .= '' . "\n"; + } + + // output real data + foreach ($audience as $record) { + $i++; + + /** + * CUSTOMIZATION STEP 3: + * 3. Add the new field to the output. + * The field's data is represented as: $record['FIELD_NAME_HERE'], as seen in the existing fields below. + * Be sure to add it for both the XML format and the non-XML format, for consistency. Again, follow the pattern. + */ + if ($format === "XML") { + $exporter_output .= "\n"; + $exporter_output .= " \n"; + $exporter_output .= " " . $record['customers_firstname'] . "\n"; + $exporter_output .= " " . $record['customers_lastname'] . "\n"; + $exporter_output .= " " . $record['customers_email_address'] . "\n"; + $exporter_output .= " " . ($record['entry_company'] ?? '') . "\n"; + $exporter_output .= " " . ($record['customers_telephone'] ?? '') . "\n"; + $exporter_output .= " \n"; + } else { // output non-XML data-format + $exporter_output .= $LINESTART; + $exporter_output .= $FIELDSTART . $record['customers_email_address'] . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . $record['customers_firstname'] . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . $record['customers_lastname'] . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . ($record['entry_company'] ?? '') . $FIELDEND; + $exporter_output .= $FIELDSEPARATOR; + $exporter_output .= $FIELDSTART . ($record['customers_telephone'] ?? '') . $FIELDEND; + $exporter_output .= $LINEBREAK; + } + } + + if ($format === "HTML") { + $exporter_output .= $NL . "
"; + } + if ($format === "XML") { + $exporter_output .= "\n"; + } + + + // theoretically, $i should === $records at this point. + + // status message + $messageStack->add($records . ' ' . TEXT_PROCESSED, 'success'); + + // begin streaming file contents + if ($is_attachment) { + if ($format === "CSV" || $format === "TXT") { + $content_type = 'text/x-csv'; + } elseif ($format === "XML") { + $content_type = 'text/xml; charset=' . CHARSET; + } + if (str_contains($_SERVER['HTTP_USER_AGENT'], "MSIE")) { + header('Content-Type: application/octetstream'); +// header('Content-Type: '.$content_type); +// header('Content-Disposition: inline; filename="' . $file . '"'); + header('Content-Disposition: attachment; filename=' . $file); + header("Expires: Mon, 26 Jul 2001 05:00:00 GMT"); + header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT"); + header("Cache-Control: must_revalidate, post-check=0, pre-check=0"); + header("Pragma: public"); + header("Cache-control: private"); + } else { + header('Content-Type: application/x-octet-stream'); +// header('Content-Type: '.$content_type); + header('Content-Disposition: attachment; filename=' . $file); + header("Expires: Mon, 26 Jul 2001 05:00:00 GMT"); + header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT"); + header("Pragma: no-cache"); + } + echo $exporter_output; + session_write_close(); + exit; + } + + echo $exporter_output; + session_write_close(); + exit; + } //end if $records for processing not 0 + + zen_redirect(zen_href_link(FILENAME_EMAIL_EXPORT)); +} + +?> + +> + + + + + + + +
+ +

+ +
+ + +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+ +
+ +
+
+ +
+ + +
+ + ' ?> +
+ + + +
+ + + +
+ + + diff --git a/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/css/emails_export.css b/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/css/emails_export.css new file mode 100644 index 0000000..d73c5fc --- /dev/null +++ b/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/css/emails_export.css @@ -0,0 +1,5 @@ +/* + * css for emails_export + */ + +@media print{@page {size: landscape;}} diff --git a/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/extra_datafiles/emails_export.php b/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/extra_datafiles/emails_export.php new file mode 100644 index 0000000..93104c0 --- /dev/null +++ b/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/extra_datafiles/emails_export.php @@ -0,0 +1,9 @@ + 'Export Email Addresses', +]; + +return $define; diff --git a/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/languages/english/lang.emails_export.php b/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/languages/english/lang.emails_export.php new file mode 100755 index 0000000..10dffdc --- /dev/null +++ b/zc_plugins/EmailAddressExporter/v2.0.0/admin/includes/languages/english/lang.emails_export.php @@ -0,0 +1,31 @@ + 'Export Email Addresses', + + 'TEXT_EMAIL_EXPORT_FORMAT' => 'Export File Format:', + 'TEXT_PLEASE_SELECT_AUDIENCE' => 'Please choose the desired group of customers:', + 'TEXT_EMAIL_EXPORT_FILENAME' => 'Export Filename:', + 'ERROR_PLEASE_SELECT_AUDIENCE' => 'Error: Please select an audience list to export', + 'TEXT_PROCESSED' => 'Processed.', + + 'TEXT_INSTRUCTIONS' => ' +INSTRUCTIONS
You can use this page to export your Zen Cart customers and/or newsletter subscribers list to a CSV or TXT file for easy import into an email program\'s address book.
+Thus, you can use a 3rd-party emailing tool for sending your advertising newsletters, etc.

+1. Choose your export format.
+2. Choose the snapshot of customer info (recipient list).
+3. Enter a filename. Consider your choice of file extension (must end in one of: .csv .txt .htm .xml).
+    If you use .TXT, you can save it or open it in a Text Editor directly.
+    If you use .CSV, you can save it or open it in a spreadsheet program directly.
+    If you use .XML, you can save it for import into another application.
+    If you use .HTML the output will be shown directly on-screen, without downloading.
+4. Click Save to proceed.
+5. You may be prompted to save the downloaded file, or it may download automatically according to browser settings.' +]; + +return $define; diff --git a/zc_plugins/EmailAddressExporter/v2.0.0/manifest.php b/zc_plugins/EmailAddressExporter/v2.0.0/manifest.php new file mode 100644 index 0000000..7a4bde9 --- /dev/null +++ b/zc_plugins/EmailAddressExporter/v2.0.0/manifest.php @@ -0,0 +1,13 @@ + 'v2.0.0', + 'pluginName' => 'Export Email Addresses', + 'pluginDescription' => 'Export customer email addresses.', + 'pluginAuthor' => 'DrByte and others', + 'pluginId' => 6, // ID from Zen Cart forum + 'zcVersions' => ['v200', 'v158', 'v210'], + 'changelog' => '', // online URL (eg github release tag page, or changelog file there) or local filename only, ie: changelog.txt (in same dir as this manifest file) + 'github_repo' => '', // url + 'pluginGroups' => [], +];