Rewrote some parts:
[mailer.git] / inc / extensions / ext-newsletter.php
index 98b2b238557ddc8a9b1bcbd940ef8920d67c2bbf..1ff4ca2acdcee39febeb8ef5ce41780f26d67cb9 100644 (file)
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * 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 *
@@ -45,11 +43,14 @@ if (!defined('__SECURITY')) {
 // Version number
 setThisExtensionVersion('0.2.0');
 
-// Version history array (add more with , '0.1.0' and so on)
-setExtensionVersionHistory(array('0.0', '0.0.1', '0.0.2', '0.0.3', '0.0.4', '0.0.5', '0.0.6', '0.0.7', '0.0.8', '0.0.9', '0.1.0', '0.1.1', '0.1.2', '0.2.0'));
+// Version history array (add more with , '0.0.1' and so on)
+setExtensionVersionHistory(array('0.0.0', '0.0.1', '0.0.2', '0.0.3', '0.0.4', '0.0.5', '0.0.6', '0.0.7', '0.0.8', '0.0.9', '0.1.0', '0.1.1', '0.1.2', '0.2.0'));
+
+// This extension is in development (non-productive)
+enableExtensionProductive(FALSE);
 
 switch (getExtensionMode()) {
-       case 'register': // Do stuff when installation is running (modules.php?module=admin is called)
+       case 'setup': // Do stuff when installation is running
                // SQL commands to run
                addExtensionSql('');
                break;
@@ -58,98 +59,92 @@ switch (getExtensionMode()) {
                // SQL commands to run
                addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='newsletter'");
                addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_member_menu` WHERE `what`='newsletter'");
-               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_data`");
-               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_topics`");
-               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_orders`");
+               addDropTableSql('newsletter_data');
+               addDropTableSql('newsletter_topics');
+               addDropTableSql('newsletter_orders');
                break;
 
        case 'activate': // Do stuff when admin activates this extension
-               // SQL commands to run
-               addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `locked`='N', `visible`='Y' WHERE `what`='newsletter' LIMIT 1");
                break;
 
        case 'deactivate': // Do stuff when admin deactivates this extension
-               // SQL commands to run
-               addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `locked`='Y', `visible`='N' WHERE `what`='newsletter' LIMIT 1");
                break;
 
        case 'update': // Update an extension
                switch (getCurrentExtensionVersion()) {
                        case '0.0.1': // SQL queries for v0.0.1
                                addAdminMenuSql('newsletter', NULL, 'Newsletter','Einstellungen am Newsletter, Newsletter versenden, usw.', 3);
-                               addAdminMenuSql('newsletter','config_newsletter','Einstellungen','Einstellungen am Newsletter vornehmen.', 3);
-                               addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `what`='newsletter' LIMIT 1");
-                               addMemberMenuSql('main','newsletter','Newsletter-Empfang','N','Y', 10);
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_user_data` ADD `nl_receive` ENUM('Y','N') NOT NULL DEFAULT 'Y'");
+                               addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `what` IN ('newsletter','config_newsletter') LIMIT 1");
+                               addExtensionAddTableColumnSql('user_data', 'nl_receive', "ENUM('Y','N') NOT NULL DEFAULT 'Y'");
 
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Menüpunkte hinzufügen und Mitgliedereinstellung.");
+                               setExtensionUpdateNotes('Menüpunkte hinzufügen und Mitgliedereinstellung.');
                                break;
 
                        case '0.0.2': // SQL queries for v0.0.2
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("URL im Versendeformular und Option <em>Immer aktiv</em> f&uuml;r diese Erweiterung deaktiviert.");
+                               setExtensionUpdateNotes('URL im Versendeformular und Option <span class="bad">Immer aktiv</span> f&uuml;r diese Erweiterung deaktiviert.');
                                break;
 
                        case '0.0.3': // SQL queries for v0.0.3
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("W&ouml;rter <strong>{?mt_word?}</strong>, <strong>{?mt_word2?}</strong> und <strong>{?mt_word3?}</strong> sind austauschbar.");
+                               setExtensionUpdateNotes('W&ouml;rter <strong>{?mt_word?}</strong>, <strong>{?mt_word2?}</strong> und <strong>{?mt_word3?}</strong> sind austauschbar.');
                                break;
 
                        case '0.0.4': // SQL queries for v0.0.4
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("HTML-Code ausgelagert in Templates und SQL-Anweisungen abgesichert.");
+                               setExtensionUpdateNotes('HTML-Code ausgelagert in Templates und SQL-Anweisungen abgesichert.');
                                break;
 
                        case '0.0.5': // SQL queries for v0.0.5
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Abspeichern von Einstellungen repariert.");
+                               setExtensionUpdateNotes('Abspeichern von Einstellungen repariert.');
                                break;
 
                        case '0.0.6': // SQL queries for v0.0.6
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Bitte Script inc/monthly_newsletter.php l&ouml;schen!");
+                               setExtensionUpdateNotes('Bitte Script inc/monthly_newsletter.php l&ouml;schen!');
                                break;
 
                        case '0.0.7': // SQL queries for v0.0.7
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Script <strong>inc/monthly/monthly_newsletter.php</strong> wird nicht mehr ausgef&uuml;hrt, wenn die Erweiterung nicht aktiviert ist.");
+                               setExtensionUpdateNotes('Script <strong>inc/monthly/monthly_newsletter.php</strong> wird nicht mehr ausgef&uuml;hrt, wenn die Erweiterung nicht aktiviert ist.');
                                break;
 
                        case '0.0.8': // SQL queries for v0.0.8
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Sicherheitsupdate f&uuml;r die Include-Befehle.");
+                               setExtensionUpdateNotes('Sicherheitsupdate f&uuml;r die Include-Befehle.');
                                break;
 
                        case '0.0.9': // SQL queries for v0.0.9
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Nur bei installierter Erweiterung <strong>html_mail</strong> k&ouml;nnen Sie auch HTML-Mails versenden.");
+                               setExtensionUpdateNotes('Nur bei installierter Erweiterung <strong>html_mail</strong> k&ouml;nnen Sie auch HTML-Mails versenden.');
                                break;
 
                        case '0.1.0': // SQL queries for v0.2.1
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Nur bei installierter Erweiterung <strong>html_mail</strong> k&ouml;nnen Sie auch HTML-Mails versenden.");
+                               setExtensionUpdateNotes('Nur bei installierter Erweiterung <strong>html_mail</strong> k&ouml;nnen Sie auch HTML-Mails versenden.');
                                break;
 
                        case '0.1.1': // SQL queries for v0.1.1
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("W&auml;hrung auf die Erweiterung <a href=\"#\"><strong>ext-other.zip</strong></a> verlagert. Bitte auch diese aktualisieren.");
+                               setExtensionUpdateNotes('W&auml;hrung auf die Erweiterung <a href="#"><strong>ext-other.zip</strong></a> verlagert. Bitte auch diese aktualisieren.');
                                break;
 
                        case '0.1.2': // SQL queries for v0.1.2
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Fehlerhinweis bei deaktivierter Erweiterung verbessert.");
+                               setExtensionUpdateNotes('Fehlerhinweis bei deaktivierter Erweiterung verbessert.');
                                break;
 
                        case '0.2.0': // SQL queries for v0.2.0
                                // Tables:
                                // - Main data table
-                               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_data`");
-                               addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_newsletter_data` (
+                               addDropTableSql('newsletter_data');
+                               addCreateTableSql('newsletter_data', "
 `nl_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 `nl_subject` VARCHAR(255) NOT NULL DEFAULT '{OPEN_CONFIG}nl_default_subject{CLOSE_CONFIG}',
-`nl_header_text` MEDIUMTEXT,
-`nl_footer_text` MEDIUMTEXT,
+`nl_header_text` MEDIUMTEXT NOT NULL,
+`nl_footer_text` MEDIUMTEXT NOT NULL,
 `nl_created` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
 `nl_send` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
 `nl_ready` ENUM('Y','N') NOT NULL DEFAULT 'N',
@@ -159,47 +154,54 @@ switch (getExtensionMode()) {
 `nl_recipients` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `nl_received` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `nl_total_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
-PRIMARY KEY (`nl_id`)
-) TYPE={?_TABLE_TYPE?} COMMENT='General newsletter data'");
+PRIMARY KEY (`nl_id`)",
+                                       'General newsletter data');
 
                                // - Topics data table
-                               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_topics`");
-                               addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_newsletter_topics` (
+                               addDropTableSql('newsletter_topics');
+                               addCreateTableSql('newsletter_topics', "
 `nl_topic_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 `nl_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `nl_topic_title` VARCHAR(255) NOT NULL DEFAULT '',
-`nl_topic_text` MEDIUMTEXT,
-INDEX `newsletter_id` (`nl_id`),
-PRIMARY KEY (`nl_topic_id`)
-) TYPE={?_TABLE_TYPE?} COMMENT='Newsletter topics'");
+`nl_topic_text` MEDIUMTEXT NOT NULL,
+`nl_topic_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
+PRIMARY KEY (`nl_topic_id`),
+INDEX `newsletter_id` (`nl_id`)",
+                                       'Newsletter topics');
 
                                // - Sponsor orders data table
-                               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_orders`");
-                               addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_newsletter_orders` (
+                               addDropTableSql('newsletter_orders');
+                               addCreateTableSql('newsletter_orders', "
 `nl_order_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 `nl_sponsor_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `nl_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `nl_topic_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `nl_order_placed` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
 `nl_order_accepted` ENUM('Y','N') NOT NULL DEFAULT 'N',
-UNIQUE KEY `sponsor_nl_topic` (`nl_sponsor_id`,`nl_id`,`nl_topic_id`),
-INDEX `topic` (`nl_topic_id`),
-PRIMARY KEY (`nl_order_id`)
-) TYPE={?_TABLE_TYPE?} COMMENT='Newsletter orders'");
+PRIMARY KEY (`nl_order_id`),
+UNIQUE INDEX `sponsor_nl_topic` (`nl_sponsor_id`, `nl_id`, `nl_topic_id`),
+INDEX `topic` (`nl_topic_id`)",
+                                       'Newsletter orders');
 
                                // Configuration
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_expire` BIGINT(20) UNSIGNED NOT NULL DEFAULT ".(getConfig('ONE_DAY') * 7)."");
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_archive_expire` BIGINT(20) UNSIGNED NOT NULL DEFAULT ".(getConfig('ONE_DAY') * 14)."");
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_default_subject` VARCHAR(255) NOT NULL DEFAULT 'Newsletter vom {OPEN_CONFIG}CURRENT_DATE{CLOSE_CONFIG}'");
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_default_header` MEDIUMTEXT");
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_default_footer` MEDIUMTEXT");
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_archive` ENUM('Y','N') NOT NULL DEFAULT 'Y'");
+                               addConfigAddSql('nl_expire', 'BIGINT(20) UNSIGNED NOT NULL DEFAULT ' . (getOneDay() * 7));
+                               addConfigAddSql('nl_archive_expire', 'BIGINT(20) UNSIGNED NOT NULL DEFAULT ' . (getOneDay() * 14));
+                               addConfigAddSql('nl_default_subject', "VARCHAR(255) NOT NULL DEFAULT 'Newsletter vom {OPEN_CONFIG}CURRENT_DATE{CLOSE_CONFIG}'");
+                               addConfigAddSql('nl_default_header', 'MEDIUMTEXT NOT NULL,');
+                               addConfigAddSql('nl_default_footer', 'MEDIUMTEXT NOT NULL,');
+                               addConfigAddSql('nl_archive', "ENUM('Y','N') NOT NULL DEFAULT 'Y'");
 
                                // Admin menu
-                               addAdminMenuSql('newsletter', 'add_newsletter','Neuen erstellen','Legen Sie hier einen neuen Newsletter mit Betreff und Verfallsdatum an.', 1);
+                               addAdminMenuSql('newsletter', 'list_newsletter', 'Newsletter Verwalten', 'Legen Sie hier einen neuen Newsletter mit Betreff und Verfallsdatum an und listen Sie bestehende auf. Die Grunddaten lassen sich hier ebenfalls &auml;ndern.', 1);
+                               addAdminMenuSql('newsletter', 'list_newsletter_topic', 'Thema verwalten', 'Legen Sie hier ein weiteres Thema an oder editieren bzw. l&ouml;schen Sie bestehende.', 2);
+                               addAdminMenuSql('newsletter', 'list_newsletter_ordrs', 'Buchungen verwalten', 'Verwalten Sie hier die Buchungen im Newsletter von Ihren Sponsoren.', 3);
+                               addAdminMenuSql('newsletter', 'config_newsletter', 'Einstellungen', 'Einstellungen am Newsletter vornehmen.', 4);
+
+                               // Remove member menu
+                               addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_member_menu` WHERE `what`='newsletter' LIMIT 1");
 
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Komplett&uuml;berarbeitung der Erweiterung, siehe neuer Beschreibungstext.");
+                               setExtensionUpdateNotes('Komplett&uuml;berarbeitung der Erweiterung, siehe neuer Beschreibungstext.');
                                break;
                } // END - switch
                break;
@@ -207,7 +209,7 @@ PRIMARY KEY (`nl_order_id`)
        case 'modify': // When the extension got modified
                break;
 
-       case 'test': // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
+       case 'test': // For testing purposes
                break;
 
        case 'init': // Do stuff when extension is initialized
@@ -216,22 +218,22 @@ PRIMARY KEY (`nl_order_id`)
                // @TODO Move these into configuration
                $GLOBALS['url_ends'] = array(
                        ' ',
-                       "\n",
-                       "\r",
+                       PHP_EOL,
+                       chr(13),
                        ')',
                );
 
                // Valid email chars (without @, or do you want to have another @ inside your email addresses?)
                $GLOBALS['valid_email_chars'] = array(
                        'a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s',
-                       't','u','v','w','x','y','z','a','B','C','D','E','F','G','H','I','J','K','L',
-                       'M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z','-','.','_',0,1,
-                       2,3,4,5,6,7,8,9
+                       't','u','v','w','x','y','z','A','B','C','D','E','F','G','H','I','J','K','L',
+                       'M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z','-','.','_','0','1',
+                       '2','3','4','5','6','7','8','9'
                );
                break;
 
        default: // Unknown extension mode
-               logDebugMessage(__FILE__, __LINE__, sprintf("Unknown extension mode %s detected.", getExtensionMode()));
+               reportBug(__FILE__, __LINE__, sprintf('Unknown extension mode %s in extension %s detected.', getExtensionMode(), getCurrentExtensionName()));
                break;
 } // END - switch