Changeset 171

Timestamp:

Jan 29, 2007 11:38:31 PM (6 years ago)

Author:

dkg

Message:

JPDD: created initial broadcast e-mail infrastructure.

Location:

trunk/jpdd

Files:

• class.dkg.site.php (modified) (6 diffs)
• class.jpdd.php (modified) (2 diffs)
• config.inc.php (modified) (1 diff)
• sql/basics.sql (modified) (2 diffs)
• sql/db.sql (modified) (5 diffs)
• web/styles.css (modified) (1 diff)

trunk/jpdd/class.dkg.site.php

@@ -135 +135 @@
 
     // we're relying on a functioning mail() function.
-    function mail($type, $to,$subj,$body, $hdrs = array()) {
+    // returning true means it actually was queued for delivery.
+    // returning false means it was never queued.
+    function mail($type, $to,$subj,$body, $hdrs = array(), $broadcast_id = NULL) {
       if (!is_array($hdrs))
         $hdrs = array($hdrs);
@@ -142 +144 @@
 
       // log it:
-      $this->executeSQL('INSERT INTO mail_log (mail_from, mail_to, subject, body, extra_headers, message_type, actually_sent) VALUES ('.$this->escStr($this->_site_email_from).','.
+      $this->executeSQL('INSERT INTO mail_log (mail_from, mail_to, subject, body, extra_headers, message_type, actually_sent, broadcast_id) VALUES ('.$this->escStr($this->_site_email_from).','.
                         $this->escStr($to).','.
                         $this->escStr($subj).','.
@@ -148 +150 @@
                         $this->escStr($hdrs).','.
                         $this->escStr($type).','.
-                        ($this->_actually_send_email ? 'true' : 'false').
+                        ($this->_actually_send_email ? 'true' : 'false').','.
+                        $this->intOrDefault($broadcast_id).
                         ')', false);
       if ($this->_actually_send_email)
-        mail($to, $subj, $body, $hdrs);
+        return mail($to, $subj, $body, $hdrs);
+      else
+        return false; // we didn't actually send the mail.
     }
 
@@ -185 +190 @@
 
     function getAllowedActions() {
-      return array('edit', 'login', 'logout', 'resetpass', 'newacct');
+      return array('edit', 'login', 'logout', 'resetpass', 'newacct', 'broadcast');
     }
     
@@ -963 +968 @@
           }
         }
+      } elseif ($this->_action == 'broadcast') {
+        if ($this->_authenticated_user->HasAllOfThesePrivileges('Send Broadcast')) {
+          if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+            if ($_POST['submit'] == 'Send') {
+              return $this->sendBroadcastEmails();
+            } else {
+              return $this->getBroadcastEmailForm();
+            }
+          } else {
+            return $this->getBroadcastEmailForm();
+          }
+        } else
+          return $this->permissionDenied('Broadcast not allowed.');
       } else {
         return $this->getMainContentExtended();
       }
+    }
+
+    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();')));
+    }
+    
+    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() {
+      $selectors = $this->getBroadcastSelectors();
+      return '<select name="selector">
+'.join("\n", array_map(create_function('$v, $l', 'global $dkg_site; return "<option value=\"".$v."\">".$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'];
+      
+      $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;
+      reset($objs);
+      while(list(,$obj) = each($objs)) {
+        $to = $obj->_email;
+        $subj = trim(str_replace("\n", '', $this->applyBroadcastTemplate($subj, $obj)));
+        $body = trim(wordwrap($this->applyBroadcastTemplate($content, $obj)));
+        $attempted++;
+        if ($this->mail('broadcast', $to,$subj,$body, array(), $bid))
+          $succeeded++;
+      }
+      return $succeeded.' out of '.$attempted.' mails sent.';
+    }
+
+    function getBroadcastEmailForm() {
+      $subj = '';
+      $content = '';
+      $preview = '';
+      $ret = '';
+
+      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'];
+        
+        $selector = $_POST['selector'];
+        $selectors = $this->getBroadcastSelectors();
+        if (!array_key_exists($selector, $selectors)) {
+          $this->addWarning('You chose an unavailable selector!');
+          return '';
+        }
+        $selector = $selectors[$selector];
+        
+        $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.'
+Subject: '.htmlentities(trim(str_replace("\n", '', $this->applyBroadcastTemplate($subj, $obj)))).'
+
+'.htmlentities(trim(wordwrap($this->applyBroadcastTemplate($content, $obj)))).'</pre>';
+        }
+        $preview .= '</fieldset>';
+      }
+
+      return $ret.'<form name="broadcast" action="'.$this->Path('broadcast').'" method="post">
+'.$this->getFormTokenHiddenInput().'
+<fieldset><legend>Send to:</legend>
+'.$this->getBroadcastSelectorInput().'
+</fieldset>
+'.$preview.'
+<fieldset><legend>Message Content:</legend>
+'.$this->getAllowedTemplateLegend().'
+<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>';
     }
 
@@ -1033 +1191 @@
         }
 
+    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

@@ -45 +45 @@
     }
 
+
+    function getBroadcastSelectors() {
+      // override to return an array that maps internal keys to
+      // visible labels and SQL statements.  For example:
+      return array_merge(array('dkg' => array('description' => 'People named Gillmor',
+                                              'sql' => 'SELECT * FROM person WHERE last_name = '.$this->escStr('Gillmor'))),
+                         parent::getBroadcastSelectors()
+                         );
+    }
+
     function getNavLink($title,$targ) {
       return '<a '.(($this->_action == $targ || (in_array($this->_action, array('view', 'edit')) && $this->_type == $targ)) ? 'class="current" ' : '').'href='.$this->Path($targ).'>'.$title.'</a>';
@@ -63 +73 @@
         if ($this->_authenticated_user->hasAllOfThesePrivileges('Update Workshops', 'Edit People', 'Edit Categories'))
           $links['Review Signups'] = 'overview';
+        if ($this->_authenticated_user->hasAllOfThesePrivileges('Send Broadcast'))
+          $links['E-mail Alert'] = 'broadcast';
       } else {
         if ($this->_action != 'newacct')

trunk/jpdd/config.inc.php

@@ -30 +30 @@
   // 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' => false,
+  'actually_send_email' => true,
 );

trunk/jpdd/sql/basics.sql

@@ -72 +72 @@
 --
 
-SELECT pg_catalog.setval(pg_catalog.pg_get_serial_sequence('privilege', 'id'), 7, true);
+SELECT pg_catalog.setval(pg_catalog.pg_get_serial_sequence('privilege', 'id'), 8, true);
 
 
@@ -87 +87 @@
 6       List People     This allows users to see a list of all people signed up for the conference
 7       Edit Categories This allows users to modify the available categories
+8       Send Broadcast  This allows users to broadcast templated messages to groups of signed-up users
 \.
 

trunk/jpdd/sql/db.sql

@@ -81 +81 @@
 
 ALTER TABLE public.audience_by_organization OWNER TO dkg;
+
+--
+-- Name: broadcast; Type: TABLE; Schema: public; Owner: dkg; Tablespace: 
+--
+
+CREATE TABLE broadcast (
+    id serial NOT NULL,
+    subj character varying NOT NULL,
+    body text NOT NULL,
+    selector character varying NOT NULL,
+    sender_id integer NOT NULL
+);
+
+
+ALTER TABLE public.broadcast OWNER TO dkg;
 
 --
@@ -123 +138 @@
     whattime timestamp with time zone DEFAULT now() NOT NULL,
     actually_sent boolean DEFAULT true NOT NULL,
-    message_type character varying DEFAULT 'newacct'::character varying NOT NULL
+    message_type character varying DEFAULT 'newacct'::character varying NOT NULL,
+    broadcast_id integer
 );
 
@@ -272 +288 @@
 
 --
+-- Name: broadcast_pkey; Type: CONSTRAINT; Schema: public; Owner: dkg; Tablespace: 
+--
+
+ALTER TABLE ONLY broadcast
+    ADD CONSTRAINT broadcast_pkey PRIMARY KEY (id);
+
+
+--
 -- Name: category_pkey; Type: CONSTRAINT; Schema: public; Owner: dkg; Tablespace: 
 --
@@ -453 +477 @@
 ALTER TABLE ONLY attendance
     ADD CONSTRAINT attendance_workshop_id_fkey FOREIGN KEY (workshop_id) REFERENCES workshop(id);
+
+
+--
+-- Name: broadcast_sender_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: dkg
+--
+
+ALTER TABLE ONLY broadcast
+    ADD CONSTRAINT broadcast_sender_id_fkey FOREIGN KEY (sender_id) REFERENCES person(id);
+
+
+--
+-- Name: mail_log_broadcast_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: dkg
+--
+
+ALTER TABLE ONLY mail_log
+    ADD CONSTRAINT mail_log_broadcast_id_fkey FOREIGN KEY (broadcast_id) REFERENCES broadcast(id);
 
 
@@ -574 +614 @@
 
 --
+-- Name: broadcast; Type: ACL; Schema: public; Owner: dkg
+--
+
+REVOKE ALL ON TABLE broadcast FROM PUBLIC;
+REVOKE ALL ON TABLE broadcast FROM dkg;
+GRANT ALL ON TABLE broadcast TO dkg;
+GRANT INSERT ON TABLE broadcast TO "www-data";
+
+
+--
+-- Name: broadcast_id_seq; Type: ACL; Schema: public; Owner: dkg
+--
+
+REVOKE ALL ON TABLE broadcast_id_seq FROM PUBLIC;
+REVOKE ALL ON TABLE broadcast_id_seq FROM dkg;
+GRANT ALL ON TABLE broadcast_id_seq TO dkg;
+GRANT SELECT,UPDATE ON TABLE broadcast_id_seq TO "www-data";
+
+
+--
 -- Name: category; Type: ACL; Schema: public; Owner: dkg
 --

trunk/jpdd/web/styles.css

@@ -102 +102 @@
 }
 
+
+.template-legend { 
+  background: silver;
+  color: black;
+  padding: 1em;
+  margin: 0.5em;
+}
+.template-legend dl dt { 
+ font-weight: bold;
+}
+.template-legend dl dd { 
+ font-style: italic;
+}
+
 @media print {