Changeset 606

Timestamp:

Sep 25, 2007 12:42:01 AM (6 years ago)

Author:

dkg

Message:

JPDD: completely refactored broadcast e-mails.

Location:

trunk/jpdd

Files:

• class.dkg.broadcast.php (added)
• class.dkg.site.php (modified) (7 diffs)
• class.jpdd.broadcast.php (added)
• class.jpdd.php (modified) (2 diffs)
• config.inc.php (modified) (1 diff)
• sql/db.sql (modified) (1 diff)

trunk/jpdd/class.dkg.site.php

@@ -100 +100 @@
                                               'table' => $this->_users['tablename'],
                                               'sort' => $this->_users['username']));
+      $this->addClassMapEntry('broadcast', array('classname' => 'DKG_Broadcast', 
+                                              'filename' => 'class.dkg.broadcast.php',
+                                              'table' => 'broadcast',
+                                              'sort' => 'id DESC'));
       $this->addClassMapEntry('privilege', array('classname' => 'DKG_Privilege', 
                                               'filename' => 'class.dkg.privilege.php',
@@ -197 +201 @@
 
     function getAllowedActions() {
-      return array('edit', 'login', 'logout', 'resetpass', 'newacct', 'broadcast');
+      return array('edit', 'login', 'logout', 'resetpass', 'newacct', 'send', 'copy');
     }
     
@@ -983 +987 @@
           return $this->getLoginForm(); // login form shows logout form if currently logged in.
         }
+      } elseif ($this->_action == 'copy') {
+        if ($this->isEmpty($this->_type) || $this->isEmpty($this->_identifier)) 
+          $this->error('Nothing to copy');
+        if (!$this->canCreate($this->_type))
+          return $this->permissionDenied('Creating '.$this->_type.' not allowed.');
+
+        // must be able to edit and create in order to copy?
+        $item = $this->getItem($this->_type, $this->_identifier);
+        // unset the ID.
+        $item->_id = NULL;
+        return $item->getCreationForm();
+        
       } elseif ($this->_action == 'edit') {
         if ($this->isEmpty($this->_type)) {
@@ -1011 +1027 @@
           }
         }
-      } elseif ($this->_action == 'broadcast') {
+      } elseif ($this->_action == 'send') {
         if ($this->isAuthenticated() && $this->_authenticated_user->HasAllOfThesePrivileges('Send Broadcast')) {
-          if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            // verify form token, or just quit:
-            if (!$this->verifyFormToken()) {
-              $this->addWarning('Bad form token mismatch!');
-              return '';
-            }
-            if ($_POST['submit'] == 'Send') {
-              return $this->sendBroadcastEmails();
-            } else {
-              return $this->getBroadcastEmailForm();
-            }
+          $item = $this->getItem('broadcast', $this->_identifier);
+          if ($_SERVER['REQUEST_METHOD'] != 'POST') {
+            $this->addWarning('You must POST all broadcast sending pages.');
+          } else if ($this->_type != 'broadcast') {
+            $this->addWarning('You can only send broadcast items');
+          } else if (!$this->verifyFormToken()) {
+            $this->addWarning('Bad form token mismatch!');
           } else {
-            return $this->getBroadcastEmailForm();
+            // need to actually send the damn e-mails here.
+            $item->sendEmailsToOutstandingPeople();
           }
+          return $item->getDetailView();
         } else
           return $this->permissionDenied('Broadcast not allowed.');
@@ -1034 +1048 @@
     }
 
-    function getBroadcastSelectors() {
-      // override to return an array that maps internal keys to
-      // visible labels and SQL statements.  For example:
-      return array('all' => array('description' => 'Every account with a confirmed e-mail',
-                                  'sql' => 'SELECT * FROM person WHERE pass IS NOT NULL'));
-    }
-
-    function getAllowedTemplates() {
-      // override to return an array that maps selectors to
-      // array('description' = "human readable", 'function' => actual
-      // php function)
-      return array('[[NAME]]' => array('description' => 'The person\'s name',
-                                       'function' => create_function('$x', 'return $x->getTitle();')),
-                   // FIXME: during the preview display, this feature
-                   // actually allows the previewer to see the reset
-                   // link for the user being previewed.  This is a
-                   // security flaw.
-                   '[[PASSWORD_RESET]]' => array('description' => 'A link that lets the person change hir password',
-                                       'function' => create_function('$x', 'global $dkg_site; return $dkg_site->handleResetPassRequest($x->_email, false);')));
-    }
-    
-    function getAllowedTemplateLegend() {
-      $temps = $this->getAllowedTemplates();
-      return "<div class=\"template-legend\">Allowed personalization terms:<dl>\n".
-        join('', array_map(create_function('$x,$y', 'return "<dt>".$x."</dt>\n<dd>".$y["description"]."</dd>\n";'),
-                           array_keys($temps), $temps))."</dl>\n</div>\n";
-    }
-    
-    function getBroadcastSelectorInput($selector_name = NULL) {
-      $selectors = $this->getBroadcastSelectors();
-      return '<select name="selector">
-'.join("\n", array_map(create_function('$v, $l', 'global $dkg_site; return "<option value=\"".$v."\" ".($v == "'.$selector_name.'" ? "selected" : "").">".$l["description"]." (".$dkg_site->getValueFromSQL("SELECT COUNT(*) AS count FROM (".$l["sql"].") AS selector", "count").")</option>";'), array_keys($selectors), $selectors)).'
-</select>
-';
-    }
-    
-    // $txt can be either a string or an array of strings.  the return
-    // value will match.
-    function applyBroadcastTemplate($txt, $user) {
-      $temps = $this->getAllowedTemplates();
-      $vals = array();
-      reset($temps);
-      while(list($temp,$x) = each($temps)) {
-        $vals[] = $x['function']($user);
-      }
-      return str_ireplace(array_keys($temps), $vals, $txt);
-    }
-
-    function sendBroadcastEmails() {
-      if ($_SERVER['REQUEST_METHOD'] != 'POST') {
-        $this->addWarning('You cannot send broadcasts with a GET request.');
-        return '';
-      }
-
-      $subj = $_POST['subject'];
-      $content = $_POST['content'];
-      $personal = ($_POST['personal'] == 'personal');
-      
-      $selector_name = $_POST['selector'];
-      $selectors = $this->getBroadcastSelectors();
-      if (!array_key_exists($selector_name, $selectors)) {
-        $this->addWarning('You chose an unavailable selector!');
-        return '';
-      }
-      $selector = $selectors[$selector_name];
-
-      // store this broadcast template in the database:
-      $bid = $this->insertBroadcast($subj, $content, $selector_name);
-
-      // we're gonna grab some peops:
-      $map = $this->prepClass('person');
-      $cname = $map['classname'];
-      $objs = $this->getSeriesFromSQL($selector['sql'], $cname);
-      $attempted = 0;
-      $succeeded = 0;
-      $skipped = array();
-      reset($objs);
-      while(list(,$obj) = each($objs)) {
-        $to = $obj->_email;
-        if (is_null($to) || !is_null($this->isValid('email', $to))) {
-          $skipped[] = $obj;
-        } else {
-          $subject = trim(str_replace("\n", '', $this->applyBroadcastTemplate($subj, $obj)));
-          $body = trim(wordwrap($this->applyBroadcastTemplate($content, $obj)));
-          $attempted++;
-          if ($this->mail('broadcast', $to, $subject, $body, array(), $personal, $bid))
-            $succeeded++;
-        }
-      }
-      return $succeeded.' out of '.$attempted.' mails sent.'.
-        (count($skipped) > 0 ? '<br/>Did not try the following people because they had no valid e-mail address: <ul>'.
-         join('', array_map(create_function('$x', 'return "<li>".$x->getLinkedTitle()."\n";'), $skipped)).'</ul>': '');
-    }
+
 
     function getFromAddressSelector($personal = false) {
@@ -1133 +1055 @@
 <label><input name="personal" type="radio" value="personal" '.($personal ? 'checked' : '').'>'.htmlentities(trim(str_replace("\n", '', $this->_authenticated_user->getTitle().' <'.$this->_authenticated_user->_email.'>'))).'</label>
 </div>';
-    }
-
-    function getBroadcastEmailForm() {
-      $subj = '';
-      $content = '';
-      $preview = '';
-      $ret = '';
-      $selector_name = '';
-      $from = trim(str_replace("\n", '', $this->getSiteName().' <'.$this->_site_email_from.'>'));
-      $personal = false;
-
-      if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-        if ($this->_actually_send_email)
-          $this->addWarning('Sending e-mail is actually enabled.  Please be careful with this!');
-        else 
-          $ret .= '<div>Sending e-mail is currently disabled.  Messages will be logged, but not actually sent.</div>';
-        $subj = $_POST['subject'];
-        $content = $_POST['content'];
-        $personal = (($_POST['personal'] == 'personal') && $this->isAuthenticated());
-
-        if ($personal)
-          $from = trim(str_replace("\n", '', $this->_authenticated_user->getTitle().' <'.$this->_authenticated_user->_email.'>'));
-          
-        
-        $selector_name = $_POST['selector'];
-        $selectors = $this->getBroadcastSelectors();
-        if (!array_key_exists($selector_name, $selectors)) {
-          $this->addWarning('You chose an unavailable selector!');
-          return '';
-        }
-        $selector = $selectors[$selector_name];
-        
-        $preview = '<fieldset><legend>Preview Example:</legend>';
-        
-        // we're gonna grab a person:
-        $map = $this->prepClass('person');
-        $cname = $map['classname'];
-        $data = $this->getSingletonFromSQL($selector['sql'].' LIMIT 1', false);
-        if (is_null($data)) {
-          $preview .= '<span class="error">There are no selectors which match <q>'.$selector['description'].'</q></span>';
-        } else {
-          $obj = new $cname(array('data' => $data));
-          $preview .= '<pre>To: '.$obj->_email.'
-From: '.htmlentities($from).'
-Subject: '.htmlentities(trim(str_replace("\n", '', $this->applyBroadcastTemplate($subj, $obj)))).'
-
-'.htmlentities(trim(wordwrap($this->applyBroadcastTemplate($content, $obj)))).'</pre>';
-        }
-        $preview .= '</fieldset>';
-      } elseif (!$this->isEmpty($this->_type)) {
-        $template = $this->getSingletonFromSQL('SELECT * FROM broadcast WHERE id = '.(int)$this->_type);
-        $subj = $template['subj'];
-        $content = $template['body'];
-      }
-
-      $alternates = $this->getMultiSeriesFromSQLByValue('SELECT broadcast.id AS id,MAX(subj) AS subj,DATE(whattime) AS date, COUNT(*) AS count from broadcast JOIN mail_log ON (broadcast_id = broadcast.id) GROUP BY broadcast.id,DATE(whattime) ORDER BY broadcast.id DESC', 'id');
-      if (count($alternates) > 0) {
-        $altout = '<div class="collapse" id="previous-broadcasts"><div class="title">Previous Broadcast E-mails:</div><div class="notes">click message subject to see or resubmit text from these messages</div><ul>';
-        reset($alternates);
-        while(list($id,$temp) = each($alternates)) {
-          $altout .= '<li'.((!$this->isEmpty($this->_type)) && ($this->_type == $id) ? ' class="selected"' : '' ).'><a href="'.$this->Path('broadcast', (int)$id).'">'.htmlentities($temp[0]['subj']).'</a><ul>'.
-            join("\n", array_map(create_function('$x', 'return $x["date"]."<div class=\"notes\">[sent to: ".$x["count"].($x["count"] == 1 ? " person" : " people")."]</div>";'), $temp)).'</ul></li>';
-        }
-        $altout .= '</ul></div>';
-        $ret .= $altout;
-      }
-
-      return $ret.'<form name="broadcast" action="'.$this->Path('broadcast').'" method="post">
-'.$this->getFormTokenHiddenInput().'
-<fieldset><legend>Send to:</legend>
-'.$this->getBroadcastSelectorInput($selector_name).'
-</fieldset>
-'.$preview.'
-<fieldset><legend>Message Content:</legend>
-'.$this->getAllowedTemplateLegend().'
-From: '.$this->getFromAddressSelector($personal).'<br />
-<label>Subject:<br />
-<input name="subject" type="text" size="60" value="'.htmlentities($subj).'" /><br />
-<label>Body:<br />
-<textarea name="content" rows="20" cols="72">'.htmlentities($content).
-        '</textarea>
-</label><br/>
-<input type="submit" class="submit" name="submit" value="Preview"/>
-'.($_SERVER['REQUEST_METHOD'] == 'POST' ? '<input class="submit" type="submit" name="submit" value="Send"/>' : '').'
-</fieldset>
-</form>';
     }
 
@@ -1289 +1125 @@
         }
 
-    function insertBroadcast($subj, $body, $selector) {
-       $this->executeSQL('INSERT INTO broadcast (subj, body, selector, sender_id) VALUES ('.$this->escStr($subj).', '.
-                         $this->escStr($body).', '.
-                         $this->escStr($selector).', '.
-                         (int)$this->_authenticated_user->getID().')');
-       // return the last id from the log:
-       return (int)$this->getValueFromSQL('SELECT currval(\'broadcast_id_seq\') AS broadcast_id', 'broadcast_id');
-    }
-
     function log($data) {
        $this->executeSQL('INSERT INTO log (data, backtrace, servervars) VALUES ('.$this->escStr($data).', '.

trunk/jpdd/class.jpdd.php

@@ -24 +24 @@
                                               'table' => 'person',
                                               'sort' => 'lower(last_name),lower(first_name)'));
+      // likewise for DKG_Broadcast:
+      $this->addClassMapEntry('broadcast', array('classname' => 'JPDD_Broadcast', 
+                                              'filename' => 'class.jpdd.broadcast.php',
+                                              'table' => 'broadcast',
+                                              'sort' => 'id DESC'));
       $this->addClassMapEntry('category', array('classname' => 'JPDD_Category', 
                                                 'filename' => 'class.jpdd.category.php',
@@ -56 +61 @@
       $this->_stylesheets[] = 'jpdd.css';
     }
-
-
-    function getBroadcastSelectors() {
-      // override to return an array that maps internal keys to
-      // visible labels and SQL statements.  For example:
-      $roles = $this->getAll('role');
-      $rsel = array(); // the per-role selectors
-      reset($roles);
-      while(list(,$role) = each($roles)) {
-        $rsel['role:'.$role->getID()] = array('description' => 'All people acting as '.$role->getTitle(),
-                                              'sql' => 'SELECT person.* FROM person JOIN person_role ON (person_id = person.id) WHERE role_id = '.$role->getID().
-                                              ' AND event_id = '.$this->getActiveEventID());
-      }
-      // get a list of all 
-
-      return array_merge(array('presenters' => array('description' => 'Workshop Presenters',
-                                                     'sql' => 'SELECT person.* FROM person JOIN presenter ON (person.id = presenter.person_id) JOIN workshop ON (workshop_id = workshop.id) WHERE event_id = '.$this->getActiveEventID()),
-                               'attendees' => array('description' => 'Workshop Attendees',
-                                                    'sql' => 'SELECT person.* FROM person JOIN audience ON (person.id = audience.person_id) JOIN workshop ON (workshop_id = workshop.id) WHERE event_id = '.$this->getActiveEventID()),
-                               'jpdd_admins' => array('description' => 'People named Gillmor or Tashlik',
-                                              'sql' => 'SELECT * FROM person WHERE last_name IN (\'Gillmor\', \'Tashlik\')')),
-                         $rsel,
-                         parent::getBroadcastSelectors()
-                         );
-    }
-
-    function getAllowedTemplates() {
-      // override to return an array that maps selectors to
-      // array('description' = "human readable", 'function' => actual
-      // php function)
-      return array_merge(parent::getAllowedTemplates(),
-                         // FIXME: these are pretty broken, actually, particularly if there is more than one workshop being attended.
-                         array('[[WORKSHOP]]' => array('description' => 'The workshop the person is attending (or "no workshop")',
-                                                       'function' => create_function('$x', '$ws = $x->getM2MPeers("workshop", "attendance"); if (count($ws) == 0) return "no workshop"; return join(", ", array_map(create_function(\'$x\', \'return html_entity_decode($x->getTitle());\'), $ws));')),
-                               '[[ROOM]]' => array('description' => 'The room number of the attended workshop (e.g. "Room 143" or "no room")',
-                                                   'function' => create_function('$x', '$ws = $x->getM2MPeers("workshop", "attendance"); if (count($ws) == 0) return "no room"; return join(", ", array_map(create_function(\'$x\', \'$rr = $x->getAssignedRoom(); return (is_null($rr) ? "no room" : "Room ".$rr->getTitle());\'), $ws));')))
-                         );
-    }
-
 
     function getNavLink($title,$targ) {

trunk/jpdd/config.inc.php

@@ -32 +32 @@
   // if this is set to false, no e-mail will actually go out, though
   // it will be written to the log.  Defaults to true.
-  'actually_send_email' => true,
+  'actually_send_email' => false,
   
   // signup closed message: if not null, the signups will be closed,

trunk/jpdd/sql/db.sql

@@ -925 +925 @@
 
 ALTER TABLE attendance_requirements ADD CONSTRAINT attendence_requirements_category_event_unique UNIQUE (category_id,event_id);
+
+-- remember whether each broadcast was sent out as a personalized
+-- mail, (false means it was sent out from the site-wide e-mail address):
+ALTER TABLE broadcast ADD COLUMN personal boolean;
+UPDATE broadcast SET personal = true; 
+ALTER TABLE broadcast ALTER COLUMN personal SET NOT NULL;
+
+-- we're allowing editing of broadcast templates now:
+GRANT UPDATE ON broadcast TO "www-data";