Source for file billing.php

Documentation is available at billing.php

  1. <?php
  2. /**
  3. * Send billing data by email
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Actions
  11. *
  12. *  path (bumblebee root)/inc/actions/billing.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. require_once 'inc/bb/configreader.php';
  20.  
  21. /** parent object */
  22. require_once 'inc/actions/export.php';
  23. /** ExportType and formatting */
  24. require_once 'inc/export/exporttypes.php';
  25. /** Export formatting codes */
  26. require_once 'inc/exportcodes.php';
  27. /** db interrogation object */
  28. require_once 'inc/formslib/dblist.php';
  29.  
  30. /**
  31. * Send billing data by email
  32. *
  33. *  Find out what sort of report is required and generate it
  34. *
  35. * @package    Bumblebee
  36. * @subpackage Actions
  37. */
  38. class ActionBilling extends ActionExport {
  39.   /**
  40.   * should all group leaders be send the email or just the logged in user
  41.   * @var boolean 
  42.   */
  43.   var $emailIndividuals = false;
  44.   /**
  45.   * mail error message (if sending mail went wrong)
  46.   * @var string 
  47.   */
  48.   var $mail_error = NULL;
  49.   /**
  50.   * enable additional debugging information for PDF generation
  51.   * @var boolean 
  52.   */
  53.   var $DEBUG_PDF = false;
  54.  
  55.   /**
  56.   * Initialising the class
  57.   *
  58.   * @param  BumblebeeAuth $auth  Authorisation object
  59.   * @param  array $pdata   extra state data from the call path
  60.   * @return void nothing
  61.   */
  62.   function ActionBilling($auth, $pdata) {
  63.     parent::ActionExport($auth, $pdata);
  64.     //$this->format = EXPORT_FORMAT_VIEW;
  65.     $this->format = EXPORT_FORMAT_PDF;
  66.     $this->_verb = 'billing';
  67.     $this->PD['what'] = 'billing';
  68.     $this->reportSet = array('group' => 'users',
  69.                              'bookingbilling' => 'groups',
  70.                              'consumablegroup' => 'users',
  71.                              'billing' => '');
  72.   }
  73.  
  74.   function mungeInputData() {
  75.     $this->emailIndividuals = issetSet($_POST, 'emailToGroups');
  76.     //echo $this->emailIndividuals ? 'true' : 'false';
  77.     parent::mungeInputData();
  78.   }
  79.  
  80.   /**
  81.   * convenience function to generate a submit button
  82.   */
  83.   function _goButton() {
  84.     echo '<label>'
  85.           .'<input type="radio" name="emailToGroups" value="0" checked="checked" /> '
  86.           .T_('Email report to me').' ('.xssqw($this->auth->email).')'
  87.         .'</label><br/>';
  88.     echo '<label>'
  89.           .'<input type="radio" name="emailToGroups" value="1" /> '
  90.           .T_('Email report to each group leader')
  91.         .'</label><br/><br/>';
  92.     parent::_goButton();
  93.   }
  94.  
  95.   /**
  96.   * get all the data and send it back to the user
  97.   */
  98.   function returnExport() {
  99.     #$this->DEBUG=10;
  100.     $lists = array();
  101.     $pdfs = array();
  102.     $nopdfs = array();
  103.     foreach ($this->reportSet as $report => $pivot) {
  104.       $this->PD['pivot'] = $pivot;
  105.       $lists[] = $this->_getDataList($report);
  106.       # preDump($lists);
  107.     }
  108.     $groups = $this->_limitationSet(array('groups'), count($this->reportSet)-1, false);
  109.     #preDump($groups);
  110.     $noData = true;
  111.     foreach ($groups['groups'] as $g) {
  112.       $noGroupData = true;
  113.       $exportArray = new ArrayExport($lists[0], '');
  114.       $exportArray->header = $this->_reportHeader();
  115.       $exportArray->author = $this->auth->name;
  116.       for ($r = 0; $r < count($lists); $r++) {
  117.         // put a restriction on what to return for this incarnation
  118.         $l = clone($lists[$r]);
  119.         $l->unionrestriction[] = 'groups.id = '.$g;   // $g is already qw($g)
  120.         $l->restriction[] = 'groups.id = '.$g;   // $g is already qw($g)
  121.         $l->fill();
  122.         $noData = $noData && ! count($l->data);
  123.         $noGroupData = $noGroupData && ! count($l->data);
  124.         $this->log('Found '. count($l->data) .' rows');
  125.  
  126.         if (count($l->data)) {
  127.           // start rendering the data
  128.           $l->outputFormat = $this->format;
  129.           $l->formatList();
  130.           $this->log('Creating new AE');
  131.           //preDump($lists[$r]);
  132.           $ea = new ArrayExport($l, $l->breakfield);
  133.           $ea->header = $this->_reportHeader();
  134.           $ea->makeExportArray();
  135.           $this->log('Appending EA');
  136.           #preDump(count($exportArray->export));
  137.           $exportArray->appendEA($ea);
  138.           #preDump(count($exportArray->export));
  139.         }
  140.       }
  141.       //preDump($exportArray);
  142.       $who = quickSQLSelect('groups', 'id', unqw($g));
  143.       if (! $noGroupData) {
  144.         $filename = $this->_getReportFilename($who['name']);
  145.         $pdfExport = $this->_preparePDFExport($exportArray);
  146.         $pdfExport->filename = $filename;
  147.         $pdfExport->useBigTable = false;
  148.         if ($this->DEBUG_PDF) {
  149.           $pdfExport->writeToFile = true;
  150.         } else {
  151.           $pdfExport->writeToFile = false;
  152.         }
  153.         $pdfExport->makePDFBuffer();
  154.         $pdfs[] = array('filename'  => $filename,
  155.                         'mimetype'  => $this->mimetype,
  156.                         'data'      => $pdfExport->export,
  157.                         'groupdata' => $who);
  158.       } else {
  159.         // if there was no data, then record that fact for later reporting.
  160.         $nopdfs[] = array('groupdata' => $who);
  161.       }
  162.     }
  163.     if ($noData) {
  164.       return $this->unbufferForError('<p>'.T_('No data found for those criteria').'</p>');
  165.     } else {
  166.       // dump out the files via email or a zip file....
  167.       $this->unbuffer();
  168.       if ($this->emailIndividuals) {
  169.         $success = 1;
  170.         for ($group=0; $group<count($pdfs); $group++) {
  171.           $success &= $this->_sendPDFbyEmail($pdfs[$group]['groupdata']['name'],
  172.                                             $pdfs[$group]['groupdata']['email'],
  173.                                             $pdfs[$group]['groupdata'],
  174.                                             array($pdfs[$group]));
  175.         }
  176.       } else {
  177.         $grouplist = array();
  178.         for ($group=0; $group<count($pdfs); $group++) {
  179.           $grouplist[] = $pdfs[$group]['groupdata']['longname'];
  180.         }
  181.         $gpinfo = array('name' => $this->auth->name, 'longname' => "\n".join($grouplist, "\n"));
  182.         $success = $this->_sendPDFbyEmail($this->auth->name, $this->auth->email, $gpinfo, $pdfs);
  183.       }
  184.       if ($success) {
  185.         $s = '<div class="msgsuccess">'
  186.             .T_('Reports sent by email.').'</div>';
  187.         echo $s;
  188.       } else {
  189.         $s = '<div class="msgerror">'
  190.             .T_('An error occured sending reports by email.').' '
  191.             .(empty($this->mail_error)
  192.                   ? T_('An unknown error occured.')
  193.                   : sprintf(T_('The mail function said: <pre>%s</pre>'), $this->mail_error))
  194.             .'</div>';
  195.         echo $s;
  196.       }
  197.       if (count($nopdfs)) {
  198.         $s = '<div class="msgerror">'
  199.             .T_('<b>Note:</b> no billing data was found for some groups.').'<br/><br/>';
  200.         foreach ($nopdfs as $group) {
  201.           $s .= xssqw($group['groupdata']['name']).': '
  202.                .xssqw($group['groupdata']['longname']).'<br/>';
  203.         }
  204.         $s .= '</div>';
  205.         echo $s;
  206.       }
  207.       echo '<div>'.T_('Regenerate reports:').'<br/><br/>';
  208.       $this->_goButton();
  209.       echo '</div>';
  210.     }
  211.   }
  212.  
  213.   /**
  214.   * obtain an appropriate filename for the data export
  215.   */
  216.   function _getReportFilename($who) {
  217.     $conf = ConfigReader::getInstance();
  218.     $name = $conf->value('billing', 'filename');
  219.     $this->mimetype = 'application/pdf';
  220.     $who = urlencode($who);
  221.     $name = preg_replace('/__date__/', strftime('%Y%m%d-%H%M%S', time()), $name);
  222.     $name = preg_replace('/__who__/', $who, $name);
  223.     return $name;
  224.   }
  225.  
  226.   /**
  227.   * send the PDF to the appropriate person by email
  228.   * the logged in user is always included in the To list for their records
  229.   *
  230.   * @param string $toName  name of the person to receive the email
  231.   * @param string $toEmail  email addr of recipient
  232.   * @param string $group   name of the group for which this report is being generated
  233.   * @param string $data    PDF data to be sent
  234.   */
  235.   function _sendPDFbyEmail($toName, $toEmail, $group, $data) {
  236.     $conf = ConfigReader::getInstance();
  237.     $eol = "\r\n";
  238.     //$from = $conf->value('billing', 'emailFromName').' <'.$conf->value('main','SystemEmail').'>';
  239.     $from = $conf->value('main', 'SystemEmail');
  240.     $returnpath = $conf->value('main', 'SystemEmail');
  241.     $replyto = $this->auth->name.' <'.$this->auth->email.'>';
  242.     $cc   = $this->auth->name.' <'.$this->auth->email.'>';    // CC a copy to the sender
  243.     $to   = $toName.' <'.$toEmail.'>';
  244.     $recipient_list = array($this->auth->email, $toEmail);
  245.     srand(time());
  246.     $id   = '<bumblebee-'.time().'-'.rand().'@'.$_SERVER['SERVER_NAME'].'>';
  247.  
  248.     // Try to work around various PHP bugs in sending mail
  249.     // see: http://marc.theaimsgroup.com/?l=php-dev&m=109286883222906&w=2
  250.     //      http://bugs.php.net/bug.php?id=28976
  251.     if(strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && ! ini_get("sendmail_from")){
  252.       ini_set("sendmail_from", $from);
  253.       $server = $conf->value('email', 'smtp_server');
  254.       if ($server) ini_set('SMTP', $server);
  255.       $port = $conf->value('email', 'smtp_port');
  256.       if ($port) ini_set('smtp_port', $port);
  257.     }
  258.  
  259.     $headers  = 'Return-path: '.$returnpath .$eol;
  260.     $headers .= 'From: '.$from .$eol;
  261.     //$headers .= 'To: '.$to .$eol;    // automatically added by mail()
  262.     //$headers .= 'Cc: '.$cc .$eol;    // automatically added by mail() ?
  263.     $headers .= 'Reply-To: '.$replyto.$eol;
  264.     $headers .= 'Message-id: ' .$id .$eol;
  265.  
  266.     $start = $this->_daterange->getStart();
  267.     $stop  = $this->_daterange->getStop();
  268.  
  269.     $textmessage = $this->_getEmailText($group, $start->dateString(), $stop->dateString());
  270.  
  271.     //$textmessage = 'Please find attached PDF billing summaries for instrument usage.';
  272.     $subject = ($conf->value('billing', 'emailSubject')
  273.                     ? $conf->value('billing', 'emailSubject') : T_('Instrument usage summary'));
  274.  
  275.     //Having read in the data for the file attachment,
  276.     //we need to set up the message headers to send a multipart/mixed message:
  277.  
  278.     // Generate a boundary string
  279.     $semi_rand = md5(time());
  280.     $mime_boundary = "==Multipart_Boundary_x{$semi_rand}x";
  281.  
  282.     // Add the headers for a file attachment
  283.     $headers .= 'MIME-Version: 1.0'.$eol
  284.                .'Content-Type: multipart/mixed;'.$eol
  285.                .' boundary="'.$mime_boundary.'"'.$eol;
  286.  
  287.     // Add a multipart boundary above the plain message
  288.     $message = 'This is a multi-part message in MIME format.'.$eol .$eol
  289.                .'--'.$mime_boundary.$eol
  290.                .'Content-Type: text/plain; charset="iso-8859-1"'.$eol
  291.                .'Content-Transfer-Encoding: 7bit' .$eol.$eol
  292.                .$textmessage .$eol.$eol;
  293.  
  294.     for ($att=0; $att<count($data); $att++) {
  295.       //echo strlen($data[$att]['data']);
  296.       // Base64 encode the file data
  297.       $attdata = chunk_split(base64_encode($data[$att]['data']));
  298.  
  299.       // Add file attachment to the message
  300.       $message .= '--'.$mime_boundary . $eol
  301.                  .'Content-Type: '.$data[$att]['mimetype'].';'.$eol
  302.                  .' name="'.$data[$att]['filename'].'"'.$eol
  303.                  .'Content-Disposition: attachment;'.$eol
  304.                  .' filename="'.$data[$att]['filename'].'"'.$eol
  305.                  .'Content-Transfer-Encoding: base64'.$eol.$eol
  306.                  .$attdata . $eol.$eol;
  307.     }
  308.     $message .= '--'.$mime_boundary.'--'.$eol;
  309.  
  310.     // Send the message
  311. /*    $fh = fopen('/tmp/mail.mbox', 'w');
  312.     fwrite($fh, $headers.$eol.$message);
  313.     fclose($fh);
  314.     return 1;*/
  315.  
  316.     // try to get more useful error messages from the mail() function
  317.     ini_set('track_errors', true);
  318.     $php_errormsg = '';
  319.     $ok =  mail(join(', ', $recipient_list), $subject, $message, $headers);
  320.     if ($ok === false) {   // error sending mail
  321.       $this->mail_error = $php_errormsg;
  322.     }
  323.     #print "sent mail to $to, $cc\n";
  324.     return $ok;
  325.   }
  326.  
  327.   /**
  328.   * Reads the boilerplate text for the email and customise it for this email
  329.   *
  330.   * @param string $group   name of the group for which this report is being generated
  331.   * @param string $start   the start date for the report
  332.   * @param string $stop    the stop date for the report
  333.   */
  334.   function _getEmailText($group, $start, $stop) {
  335.     $conf = ConfigReader::getInstance();
  336.     $fh = fopen($conf->value('billing', 'emailTemplate'), 'r');
  337.     $txt = fread($fh, filesize($conf->value('billing', 'emailTemplate')));
  338.     fclose($fh);
  339.     $replace = array(
  340.             '/__name__/'      => $group['name'],
  341.             '/__groupname__/' => $group['longname'],
  342.             '/__start__/'     => $start,
  343.             '/__stop__/'      => $stop,
  344.             '/__host__/'      => makeAbsURL()
  345.                     );
  346.     $txt = preg_replace(array_keys($replace),
  347.                         array_values($replace),
  348.                         $txt);
  349.     return $txt;
  350.   }
  351.  
  352. } // ActionBilling
  353.  
  354. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:43 +0000 by phpDocumentor 1.3.0