classes/tasks/SubscriptionExpiryReminder.inc.php

<?php

// $Id: SubscriptionExpiryReminder.inc.php,v 1.13 2008/07/01 01:16:11 asmecher Exp $


import('scheduledTask.ScheduledTask');

class SubscriptionExpiryReminder extends ScheduledTask {

   function SubscriptionExpiryReminder() {
      $this->ScheduledTask();
   }

   function sendReminder ($subscription, $journal, $emailKey) {

      $userDao = &DAORegistry::getDAO('UserDAO');
      $subscriptionTypeDao = &DAORegistry::getDAO('SubscriptionTypeDAO');

      $journalName = $journal->getJournalTitle();
      $journalId = $journal->getJournalId();
      $user = &$userDao->getUser($subscription->getUserId());
      if (!isset($user)) return false;

      $subscriptionType = &$subscriptionTypeDao->getSubscriptionType($subscription->getTypeId());

      $subscriptionName = $journal->getSetting('subscriptionName');
      $subscriptionEmail = $journal->getSetting('subscriptionEmail');
      $subscriptionPhone = $journal->getSetting('subscriptionPhone');
      $subscriptionFax = $journal->getSetting('subscriptionFax');
      $subscriptionMailingAddress = $journal->getSetting('subscriptionMailingAddress');

      $subscriptionContactSignature = $subscriptionName;

      if ($subscriptionMailingAddress != '') {
         $subscriptionContactSignature .= "\n" . $subscriptionMailingAddress;
      }
      if ($subscriptionPhone != '') {
         $subscriptionContactSignature .= "\n" . Locale::Translate('user.phone') . ': ' . $subscriptionPhone;
      }
      if ($subscriptionFax != '') {
         $subscriptionContactSignature .= "\n" . Locale::Translate('user.fax') . ': ' . $subscriptionFax;
      }

      $subscriptionContactSignature .= "\n" . Locale::Translate('user.email') . ': ' . $subscriptionEmail;

      $paramArray = array(
         'subscriberName' => $user->getFullName(),
         'journalName' => $journalName,
         'subscriptionType' => $subscriptionType->getSummaryString(),
         'expiryDate' => $subscription->getDateEnd(),
         'username' => $user->getUsername(),
         'subscriptionContactSignature' => $subscriptionContactSignature 
      );

      import('mail.MailTemplate');
      $mail = &new MailTemplate($emailKey);
      $mail->setFrom($subscriptionEmail, $subscriptionName);
      $mail->addRecipient($user->getEmail(), $user->getFullName());
      $mail->setSubject($mail->getSubject($journal->getPrimaryLocale()));
      $mail->setBody($mail->getBody($journal->getPrimaryLocale()));
      $mail->assignParams($paramArray);
      $mail->send();
   }

   function sendJournalReminders ($journal, $curDate) {

      // Only send reminders if subscriptions are enabled
      if ($journal->getSetting('enableSubscriptions')) {

         $curYear = $curDate['year'];
         $curMonth = $curDate['month'];
         $curDay = $curDate['day'];

         // Check if expiry notification before months is enabled
         if ($journal->getSetting('enableSubscriptionExpiryReminderBeforeMonths')) {

            $beforeMonths = $journal->getSetting('numMonthsBeforeSubscriptionExpiryReminder');
            $beforeYears = (int)floor($beforeMonths/12);
            $beforeMonths = (int)fmod($beforeMonths,12);

            $expiryYear = $curYear + $beforeYears + (int)floor(($curMonth+$beforeMonths)/12);
            $expiryMonth = (int)fmod($curMonth+$beforeMonths,12);
            $expiryDay = $curDay;

            // Retrieve all subscriptions that match expiry date
            $subscriptionDao = &DAORegistry::getDAO('SubscriptionDAO');
            $dateEnd = $expiryYear . '-' . $expiryMonth . '-' . $expiryDay;
            $subscriptions = &$subscriptionDao->getSubscriptionsByDateEnd($dateEnd, $journal->getJournalId()); 

            while (!$subscriptions->eof()) {
               $subscription = &$subscriptions->next();
               $this->sendReminder($subscription, $journal, 'SUBSCRIPTION_BEFORE_EXPIRY');
            }
         }

         // Check if expiry notification before weeks is enabled
         if ($journal->getSetting('enableSubscriptionExpiryReminderBeforeWeeks')) {

            $beforeWeeks = $journal->getSetting('numWeeksBeforeSubscriptionExpiryReminder');
            $beforeDays = $beforeWeeks * 7;

            $expiryMonth = $curMonth + (int)floor(($curDay+$beforeDays)/31);
            $expiryYear = $curYear + (int)floor($expiryMonth/12);
            $expiryDay = (int)fmod($curDay+$beforeDays,31);
            $expiryMonth = (int)fmod($expiryMonth,12);            

            // Retrieve all subscriptions that match expiry date
            $subscriptionDao = &DAORegistry::getDAO('SubscriptionDAO');
            $dateEnd = $expiryYear . '-' . $expiryMonth . '-' . $expiryDay;
            $subscriptions = &$subscriptionDao->getSubscriptionsByDateEnd($dateEnd, $journal->getJournalId()); 

            while (!$subscriptions->eof()) {
               $subscription = &$subscriptions->next();
               $this->sendReminder($subscription, $journal, 'SUBSCRIPTION_BEFORE_EXPIRY');
            }
         }

         // Check if expiry notification after months is enabled
         if ($journal->getSetting('enableSubscriptionExpiryReminderAfterMonths')) {

            $afterMonths = $journal->getSetting('numMonthsAfterSubscriptionExpiryReminder');
            $afterYears = (int)floor($afterMonths/12);
            $afterMonths = (int)fmod($afterMonths,12);

            if (($curMonth - $afterMonths) <= 0) {
               $afterYears++;
               $expiryMonth = 12 + ($curMonth - $afterMonths);
            } else {
               $expiryMonth = $curMonth - $afterMonths;
            }

            $expiryYear = $curYear - $afterYears;
            $expiryDay = $curDay;

            // Retrieve all subscriptions that match expiry date
            $subscriptionDao = &DAORegistry::getDAO('SubscriptionDAO');
            $dateEnd = $expiryYear . '-' . $expiryMonth . '-' . $expiryDay;
            $subscriptions = &$subscriptionDao->getSubscriptionsByDateEnd($dateEnd, $journal->getJournalId()); 

            while (!$subscriptions->eof()) {
               $subscription = &$subscriptions->next();
               // Ensure that user does not have another, valid subscription
               if (!$subscriptionDao->isValidSubscriptionByUser($subscription->getUserId(), $journal->getJournalId())) {
                  $this->sendReminder($subscription, $journal, 'SUBSCRIPTION_AFTER_EXPIRY_LAST');
               }
            }
         }

         // Check if expiry notification after weeks is enabled
         if ($journal->getSetting('enableSubscriptionExpiryReminderAfterWeeks')) {

            $afterWeeks = $journal->getSetting('numWeeksAfterSubscriptionExpiryReminder');
            $afterDays = $afterWeeks * 7;

            if (($curDay - $afterDays) <= 0) {
               $afterMonths = 1;
               $expiryDay = 31 + ($curDay - $afterDays);
            } else {
               $afterMonths = 0;
               $expiryDay = $curDay - $afterDays;
            }

            if (($curMonth - $afterMonths) == 0) {
               $afterYears = 1;
               $expiryMonth = 12;
            } else {
               $afterYears = 0;
               $expiryMonth = $curMonth - $afterMonths;
            }

            $expiryYear = $curYear - $afterYears;

            // Retrieve all subscriptions that match expiry date
            $subscriptionDao = &DAORegistry::getDAO('SubscriptionDAO');
            $dateEnd = $expiryYear . '-' . $expiryMonth . '-' . $expiryDay;
            $subscriptions = &$subscriptionDao->getSubscriptionsByDateEnd($dateEnd, $journal->getJournalId()); 

            while (!$subscriptions->eof()) {
               $subscription = &$subscriptions->next();
               // Ensure that user does not have another, valid subscription
               if (!$subscriptionDao->isValidSubscriptionByUser($subscription->getUserId(), $journal->getJournalId())) {
                  $this->sendReminder($subscription, $journal, 'SUBSCRIPTION_AFTER_EXPIRY');
               }
            }
         }
      }
   }

   function execute() {
      $journalDao = &DAORegistry::getDAO('JournalDAO');
      $journals = &$journalDao->getEnabledJournals();

      $todayDate = array(
                  'year' => date('Y'),
                  'month' => date('n'),
                  'day' => date('j')
               );

      while (!$journals->eof()) {
         $journal = &$journals->next();

         // Send reminders based on current date
         $this->sendJournalReminders($journal, $todayDate);
         unset($journal);
      }

      // If it is the first day of a month but previous month had only
      // 30 days then simulate 31st day for expiry dates that end on
      // that day.
      $shortMonths = array(2,4,6,8,10,12);

      if (($todayDate['day'] == 1) && in_array(($todayDate['month'] - 1), $shortMonths)) {

         $curDate['day'] = 31;
         $curDate['month'] = $todayDate['month'] - 1;

         if ($curDate['month'] == 12) {
            $curDate['year'] = $todayDate['year'] - 1;
         } else {
            $curDate['year'] = $todayDate['year'];
         }

         $journals = &$journalDao->getEnabledJournals();

         while (!$journals->eof()) {
            $journal = &$journals->next();

            // Send reminders for simulated 31st day of short month
            $this->sendJournalReminders($journal, $curDate);
            unset($journal);
         }
      }

      // If it is the first day of March, simulate 29th and 30th days for February
      // or just the 30th day in a leap year.
      if (($todayDate['day'] == 1) && ($todayDate['month'] == 3)) {

         $curDate['day'] = 30;
         $curDate['month'] = 2;
         $curDate['year'] = $todayDate['year'];

         $journals = &$journalDao->getEnabledJournals();

         while (!$journals->eof()) {
            $journal = &$journals->next();

            // Send reminders for simulated 30th day of February
            $this->sendJournalReminders($journal, $curDate);
            unset($journal);
         }

         // Check if it's a leap year
         if (date("L", mktime(0,0,0,0,0,$curDate['year'])) != '1') {

            $curDate['day'] = 29;

            $journals = &$journalDao->getEnabledJournals();

            while (!$journals->eof()) {
               $journal = &$journals->next();

               // Send reminders for simulated 29th day of February
               $this->sendJournalReminders($journal, $curDate);
               unset($journal);
            }
         }
      }
   }
}

?>

---