EmailLogDAO.inc.php

<?php
 
import ('lib.pkp.classes.log.EmailLogEntry');
 
class EmailLogDAO extends DAO {
 
   function getById($logId, $assocType = null, $assocId = null) {
      $params = array((int) $logId);
      if (isset($assocType)) {
         $params[] = (int) $assocType;
         $params[] = (int) $assocId;
      }
 
      $result = $this->retrieve(
         'SELECT * FROM email_log WHERE log_id = ?' .
         (isset($assocType)?' AND assoc_type = ? AND assoc_id = ?':''),
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner =& $this->build($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $returner;
   }
 
   function _getByEventType($assocType, $assocId, $eventType, $userId = null, $rangeInfo = null) {
      $params = array(
            (int) $assocType,
            (int) $assocId,
            (int) $eventType);
      if ($userId) $params[] = $userId;
 
      $result = $this->retrieveRange(
         'SELECT  e.*
         FROM  email_log e' .
         ($userId ? ' LEFT JOIN email_log_users u ON e.log_id = u.email_log_id' : '') .
         ' WHERE  e.assoc_type = ? AND
            e.assoc_id = ? AND
            e.event_type = ?' .
            ($userId ? ' AND u.user_id = ?' : ''),
         $params,
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, 'build');
   }
 
   function getByAssoc($assocType = null, $assocId = null, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT  *
         FROM  email_log
         WHERE assoc_type = ?
            AND assoc_id = ?
         ORDER BY log_id DESC',
         array((int) $assocType, (int) $assocId),
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, 'build');
   }
 
   function &build($row) {
      $entry = $this->newDataObject();
      $entry->setId($row['log_id']);
      $entry->setAssocType($row['assoc_type']);
      $entry->setAssocId($row['assoc_id']);
      $entry->setSenderId($row['sender_id']);
      $entry->setDateSent($this->datetimeFromDB($row['date_sent']));
      $entry->setEventType($row['event_type']);
      $entry->setFrom($row['from_address']);
      $entry->setRecipients($row['recipients']);
      $entry->setCcs($row['cc_recipients']);
      $entry->setBccs($row['bcc_recipients']);
      $entry->setSubject($row['subject']);
      $entry->setBody($row['body']);
 
      HookRegistry::call('EmailLogDAO::build', array(&$entry, &$row));
 
      return $entry;
   }
 
   function insertObject(&$entry) {
      $this->update(
         sprintf('INSERT INTO email_log
            (sender_id, date_sent, event_type, assoc_type, assoc_id, from_address, recipients, cc_recipients, bcc_recipients, subject, body)
            VALUES
            (?, %s, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
            $this->datetimeToDB($entry->getDateSent())),
         array(
            $entry->getSenderId(),
            $entry->getEventType(),
            $entry->getAssocType(),
            $entry->getAssocId(),
            $entry->getFrom(),
            $entry->getRecipients(),
            $entry->getCcs(),
            $entry->getBccs(),
            $entry->getSubject(),
            $entry->getBody()
         )
      );
 
      $entry->setId($this->getInsertId());
      $this->_insertLogUserIds($entry);
 
      return $entry->getId();
   }
 
   function deleteObject($logId, $assocType = null, $assocId = null) {
      $params = array((int) $logId);
      if (isset($assocType)) {
         $params[] = (int) $assocType;
         $params[] = (int) $assocId;
      }
      return $this->update(
         'DELETE FROM email_log WHERE log_id = ?' .
         (isset($assocType)?' AND assoc_type = ? AND assoc_id = ?':''),
         $params
      );
   }
 
   function deleteByAssoc($assocType, $assocId) {
      return $this->update(
         'DELETE FROM email_log WHERE assoc_type = ? AND assoc_id = ?',
         array((int) $assocType, (int) $assocId)
      );
   }
 
   function changeUser($oldUserId, $newUserId) {
      return $this->update(
         'UPDATE email_log SET sender_id = ? WHERE sender_id = ?',
         array((int) $newUserId, (int) $oldUserId)
      );
   }
 
   function getInsertId() {
      return $this->_getInsertId('email_log', 'log_id');
   }
 
 
   //
   // Private helper methods.
   //
   function _insertLogUserIds($entry) {
      $recipients = $entry->getRecipients();
 
      // We can use a simple regex to get emails, since we don't want to validate it.
      $pattern = '/(?<=<)[^>]*(?=>)/';
      preg_match_all($pattern, $recipients, $matches);
      if (!isset($matches[0])) return;
 
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      foreach ($matches[0] as $emailAddress) {
         $user = $userDao->getUserByEmail($emailAddress);
         if (is_a($user, 'User')) {
            // We use replace here to avoid inserting duplicated entries
            // in table (sometimes the recipients can have the same email twice).
            $this->replace('email_log_users',
               array('email_log_id' => $entry->getId(), 'user_id' => $user->getId()),
               array('email_log_id', 'user_id'));
         }
      }
   }
}