Introduced wrapper function addCreateTableSql(), fixed parameter order:
[mailer.git] / inc / extensions / ext-newsletter.php
index 5f9e9f34ea6a2db9d7fc3433d3a21ec2d838de51..aed01066fb85533b6dbc77e3cd1605ee192da9e0 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 02/26/2005 *
- * ================                             Last change: 02/26/2005 *
+ * Mailer v0.2.1-FINAL                                Start: 02/26/2005 *
+ * ===================                          Last change: 02/26/2005 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : ext-newsletter.php                               *
  * $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 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -47,6 +46,9 @@ 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'));
 
+// 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)
                // SQL commands to run
@@ -57,95 +59,89 @@ 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("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `what` IN ('newsletter','config_newsletter') LIMIT 1");
                                addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_user_data` ADD `nl_receive` ENUM('Y','N') NOT NULL DEFAULT 'Y'");
 
                                // Update notes (these will be set as task text!)
-                               setExtensionUpdateNotes("Men&uuml;punkte hinzuf&uuml;gen und Mitgliedereinstellung.");
+                               setExtensionUpdateNotes('Men&uuml;punkte hinzuf&uuml;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 <em>Immer aktiv</em> 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>Mailtausch</strong>, <strong>Mailtausches</strong> und <strong>Mailtauscher</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` (
-`nl_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
+                               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,
@@ -155,50 +151,57 @@ switch (getExtensionMode()) {
 `nl_sent` ENUM('Y','N') NOT NULL DEFAULT 'N',
 `nl_expired` ENUM('Y','N') NOT NULL DEFAULT 'N',
 `nl_do_archive` ENUM('Y','N') NOT NULL DEFAULT 'Y',
-`nl_recipients` BIGINT(20) NOT NULL DEFAULT 0,
-`nl_received` BIGINT(20) NOT NULL DEFAULT 0,
-`nl_total_clicks` BIGINT(20) NOT NULL DEFAULT 0,
+`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'");
+) ENGINE = {?_TABLE_TYPE?} CHARACTER SET utf8 COLLATE utf8_general_ci COMMENT = 'General newsletter data'");
 
                                // - Topics data table
-                               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_topics`");
-                               addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_newsletter_topics` (
-`nl_topic_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
-`nl_id` BIGINT(20) NOT NULL DEFAULT 0,
+                               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,
+`nl_topic_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 INDEX `newsletter_id` (`nl_id`),
 PRIMARY KEY (`nl_topic_id`)
-) TYPE={?_TABLE_TYPE?} COMMENT='Newsletter topics'");
+) ENGINE = {?_TABLE_TYPE?} CHARACTER SET utf8 COLLATE utf8_general_ci COMMENT = 'Newsletter topics'");
 
                                // - Sponsor orders data table
-                               addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_newsletter_orders`");
-                               addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_newsletter_orders` (
-`nl_order_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
-`nl_sponsor_id` BIGINT(20) NOT NULL DEFAULT 0,
-`nl_id` BIGINT(20) NOT NULL DEFAULT 0,
-`nl_topic_id` BIGINT(20) NOT NULL DEFAULT 0,
+                               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'");
+) ENGINE = {?_TABLE_TYPE?} CHARACTER SET utf8 COLLATE utf8_general_ci COMMENT = 'Newsletter orders'");
 
                                // Configuration
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_expire` BIGINT(20) NOT NULL DEFAULT ".(getConfig('ONE_DAY') * 7)."");
-                               addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `nl_archive_expire` BIGINT(20) 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");
+                               addConfigAddSql('nl_default_footer', "MEDIUMTEXT");
+                               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;
@@ -206,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
@@ -223,14 +226,14 @@ PRIMARY KEY (`nl_order_id`)
                // 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
-               DEBUG_LOG(__FILE__, __LINE__, sprintf("Unknown extension mode %s detected.", getExtensionMode()));
+               logDebugMessage(__FILE__, __LINE__, sprintf("Unknown extension mode %s in extension %s detected.", getExtensionMode(), getCurrentExtensionName()));
                break;
 } // END - switch